Skip to content

Home

Jump to bottom
Erika Redmark edited this page Jun 26, 2014 · 27 revisions

The readme in the 'master' branch gives an overview of this project. The wiki is intended as a help documentation for getting started just playing the game (without the whole checkout and setup project in Eclipse part), as well as eventually game play mechanics and level editor usage.

As the game is a work in progress, so is this wiki.

Running the Game

Preconditions

You must have Java 7 or higher installed.

Getting Started: The immediate way

A .jar is provided (monkey_shines-0.1-SNAPSHOT-jar-with-dependencies.jar) in the root folder of the project. This is only up to date in the master branch. This allows one to quickly run the game and level editor without downloading the code and compiling it or setting it up in Eclipse.

  1. Download the monkey_shines-0.1-SNAPSHOT-jar-with-dependencies.jar file

  2. Open a terminal/command window and navigate to the directory that you downloaded the .jar file to.

  3. For the game, run java -cp monkey_shines-0.1-SNAPSHOT-jar-with-dependencies.jar org.erikaredmark.monkeyshines.MonkeyShines If you are running the game, a file chooser will open and ask you to choose a file. Since the game lacks a main menu system at this time, it is asking you to choose your world. World files end in .world and are generated by the level editor. If you don't wish to use or download the debug world (see 'Optional'), then you will have to launch the level editor first to create one.

  4. For the level editor, run java -cp monkey_shines-0.1-SNAPSHOT-jar-with-dependencies.jar org.erikaredmark.monkeyshines.editor.LevelEditor

Optional: You may want to also download the 'extra/debug_worlds' contents on the master branch. The debug world is an ongoing world that just contains some 'stuff' that is designed to test game mechanics, but it can be a good entry point to being able to play the game first before hitting the level editor.

Getting Started: The fairly quick way

You can compile the .jar yourself. You will need to download and set up Maven to do so

  1. Checkout the master branch
  2. Navigate to the folder containing the pom.xml (this should be in the "Monkey Shines" folder)
  3. run mvn install.
  4. Check for a generated folder called target in that directory. In it should contain two jar files. Choose the one that says 'with-dependencies'
  5. Perform steps 2 - 4 from 'Getting Started: The immediate way' to run the program.

Playing the Game

[See the relevant wiki page for more information on actual gameplay](Playing the Game)

Clone this wiki locally