Skip to content

Home

Jump to bottom
Erika Redmark edited this page Aug 30, 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.

You must have downloaded one of the releases from here:

https://github.com/ErikaRedmark/monkey-shines-java-port/releases

Getting Started: The immediate way

The .jar is effectively the main application that you will run to play the game or use the level editor. This allows one to quickly run the game and level editor without downloading the code and compiling it or setting it up in Eclipse. Please note that current versions of the game do NOT have easy-to-double-click-and-well-named launch icons yet.

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

  2. If you want to just play the game (no level editor) you can just double click the .jar file and open it up. Otherwise, continue to step 3.

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

  4. For the game, run java -cp monkey_shines-0.1-SNAPSHOT-jar-with-dependencies.jar org.erikaredmark.monkeyshines.MonkeyShines. As stated by step 2, you can also just double click to do this.

  5. 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, as well as 'src/resources/worlds/Spooked' for the first level of the original game. The debug world is an ongoing world that just contains some 'stuff' that is designed to test game mechanics, but the 'Spooked' level is a good entry point to playing the game, as it was also the original demo level.

Getting Started: The fairly quick way

You can compile the code and create 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 - 5 from 'Getting Started: The immediate way' to run the program.

Getting Started: The easy way

  1. Contact someone close to you and ask them to follow steps outlined in either "Getting Started: The immediate way" or "Getting Started: The fairly quick way"
  2. Get an ice-cream or something and relax for a bit.

Playing the Game

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

Clone this wiki locally