Chroma

A 2D puzzle platformer built on colors and shapes

Installation for Development

1. Clone this repository (git clone https://github.com/ProjectChroma/Chroma.git)
2. Install git-lfs using the directions at the bottom-left
3. Download Slick2D and extract its contents
4. Open Eclipse
5. Set your workspace to the folder you cloned into (i.e. C:\Users\You\workspace)
6. Create a new project called "Chroma" (same name as the folder); at the bottom, there should be a notification that the project will be configured automatically
7. Create a folder in the project called lib
8. Download gson-2.6.2.jar into lib
9. Copy slick.jar, lwjgl.jar, ibxm.jar, and natives-windows.jar from where you extracted Slick2D into lib
10. Create a folder called natives-windows in lib
11. Move natives-windows.jar into natives-windows
12. Open a command line and cd into the natives-windows folder
13. Run jar -xf natives-windows.jar to extract the jar's contents' into the folder
14. Go back to Eclipse, and refresh the project (right-click -> refresh or click -> F5)
15. Right-click the project and open "Build Path" > "Configure Build Path..."
16. Click "Add JARs..." and select gson-2.6.2.jar, slick.jar, lwjgl.jar, and ibxm.jar
17. Expand lwjgl.jar in the center area and double-click "Native library location: (None)"
18. Locate and select the natives-windows folder
19. Run io.github.projectchroma.chroma.Chroma to run the game

Exporting Game

The launcher does all of the hard work for running the game, so the export process is very simple.

1. Right-click the project in Eclipse
2. Click Export...
3. Expand "Java" and select "Runnable JAR File", then click "Next"
4. Select the run configuration for the project (should point to io.github.projectchroma.chroma.Chroma as the main class)
5. Type Chroma\Chroma.jar for the jar-file path
6. Select "Package required libraries into generated JAR"
7. Click "Finish"

Your changes should now be made to Chroma.jar in the project root, which will be detected by the launcher.