############      #######       ##########       #####     ######
#############     #######      ###########       #####    ######
####     #####    #######     #####              #####   ######
####     #####    #######     ######             #####  ######
####    ####      #######      ###########       ############
###########       #######       ###########      ############
#####  ######     #######             #####      ###### #######
#####   ######    #######            ######      ######  #######
#####    ######   #######     ###########        ######   #######
#####    ######   #######     ##########         ######    #######

Risk: The Game of World Domination

(Racket Edition)

Version 1.8a

(Note to Developers: Racket v6.3 is required to run this program. The latest version can be found here)

Project Name - Risk: Racket Edition

Included libraries, modules, and definitions files:

• The src library contains ALL source code used in the game.

  • The imgs library contains all images used in the game.
  • The bkup library contains all back-up files for program files.
  • The fonts library contains fonts used in by Racket to draw text with that font.
  • The sounds library contains mp3 source files that can play during the game using rsound, an extension to Racket that is not yet implemented in Risk.
  • The testfiles library contains programs that test functions not easily tested by check-expects.
  • The Map-Positions library contains files that store the information of hitboxes used in territories in-game.
    • map-positions.txt contains a list of hitboxes for all territories.

  (Note: The compiled library is often created by the DrRacket Racket IDE when creating errortrace files, but is not tracked by the repository using .gitignore.)

  • The dice-functs.rkt module contains functions to help simulate dice rolls during gameplay for things such as turn selection and attacks/defenses.
  • The graph.rkt module contains functions that are used for animation purposes such as point comparisons.
  • The ellipse.rkt module provides important ellipse functions used for hitboxes and math throughout programs.
  • The hit-box-determiner.rkt program allows hitboxes to be made for all territories in the game using ellipses, and outputs results to a file inside of the Map-Positions lib.
  • test-animations.rkt contains tests for any animations thought to require tests outside of their host files.
  • matdes.rkt module contains material design functions used to construct the UI.
  • sys-lists.rkt contains constants used to power the system model.
  • riskFunctions.rkt is the main thread that calls all of the modules above to create Risk, and is used to create the executable for any build.

Preferred Syntax

To require particular files, such as the modules listed above, using the Racket language follows the syntax:

(require [String path])

To require a library follows the syntax:

(require [identifier lib-name])

To provide functions for use in other programs upon request in Racket uses the syntax:

(provide function-name-1 ... function-name-x)

To provide a struct in Racket uses the syntax:

(provide (struct-out struct-id))

To provide all identifiers in a given file uses the syntax:

(provide (all-defined-out))

Images in the "imgs" library will be utilized with the bitmap function provided by Racket, with the syntax:

(bitmap [String path])

These images will be defined as global variables in the source code that they are used in.

Contributing

The project is located here. Persons interested in being an official member of this team can contact the developers at any time for more information. This will allow users read and write access to the repo at any time. Anyone that wishes to contribute anything to this project can fork the project and create a pull request that will be reviewed before implementation. Game files can be downloaded into any folder with any path, but to be updated remotely, they must have Git initialized in said folder. The best way to do this is to clone the repo using Git with the following command:

git clone https://github.com/Viviose/Risk.git

The home page for the project can be found here.

Installation

To build the game executable on Windows, run the build.bat batch file located in the root game folder. To build the game executable on Mac/Linux, run the build.sh shell script located in the root game folder.

Authors

Joshua Sanchez & Patrick "Patty G" Gallagher

Project Management Features

Bugs should be reported here.

The wiki can be found here.

Contact

Josh Sanchez (Project Manager and Head Programmer)

• E-mail: [email protected]
• Phone Number: +1(773)499-5535

Patty G (Head Programmer)

• E-mail: [email protected]
• Phone Number: +1(312)493-5743