An 'Open Day' game aimed at prospective students and their parents visiting the University of York, built as part of the Year 2 Software Engineering Project (SEPR) module.
The documentation for the code can be found here. The deliverables for the project can be found here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need to install the Java Development Kit (JDK) version 1.8 to be able to build and run the project. You can download the JDK for free from Oracle.
If you don't already have a git client installed, you'll also need one of these. Console and GUI versions are available from the git SCM website.
To create a copy of the Kroy project on your computer, navigate to the directory or folder you want to store the project, and then clone the Kroy Github project:
git clone https://github.com/ArchieGodfrey/Kroy.git
Then open the directory in an IDE or code editor, and make any changes. Remember to commit little and often.
When you open Eclipse, you need to create a workspace directory. This cannot be the Kroy directory of the project.
To open the project:
- go to
File>Import>Gradle>Existing Gradle Project - set your local Kroy project folder as the
Project root directory - click
Finishand do not configure any further settings
The project dependencies are given in build.gradle files. If you right-click on the Package explorer > Gradle > Refresh Gradle Project to rebuild the Eclipse build paths using the Gradle configurations.
To be able to run tests in VSCode using the Java Test Runner extension, you will need to edit the core/src/.classpath file and edit it to reflect the example below:
<classpathentry kind="src" path="test" output="bin/test">
<attributes>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>The code has 100% Javadoc annotation coverage and can be found in two flavours. By default, the version found on the master branch does not have firebase support. However if you switch to the firebaseDocumentation/master branch you will find a repo setup with git actions that will automatically upload the generated Javadoc to a site of your choosing.
If you would like to enable this feature, you will need to create a firebase project. Head to the Firebase Homepage and sign in with a Google account. Then go to the console and create a new project. Install the Firebase CLI then the final steps are to run
firebase init
follow the steps it outlines, then lastly
firebase deploy
Now everytime someone merges to the firebaseDocumentation/master branch (the branch can be changed in github/workflows/main.yml) the javadocs will automatically be updated.
- BadLogicGames libGDX - The game frameworks and libraries used
- Gradle - A Java build tool
- Tiled Map Editor - To edit the tiled game map
- Firebase - To host the generated Javadoc site