COVID-21 The Game

Prevent another pandemic! Fight against COVID-21 and eradicate all its mutations!

Explore the docs »

Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

This project is developed in assignment of the department of Data Science & Knowledge Engineering from the University of Maastricht.

COVID-21 is based of the board game Pandemic and contains the same rule set and similar visualization as Pandemic the board game.

The eventual goal is to create an AI for the game that together with the other players tries to defeat COVID-21 and it's mutations.

Built With

The game is developed using JMonkey Engine 3

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

In order to make a build you need the following prerequisites:

• Java SDK 16+
• Maven

Installation

1. clone or download:

git clone git@github.com:nscharrenberg/COVID-21.git

2. run maven install to install all required libraries

3. run maven compile to compile the game

4. run maven exec:java to run the game.

Run Experiments

The instructions on running the experiments are done through Intellij.

1. clone or download:

git clone git@github.com:nscharrenberg/COVID-21.git

2. Open the directory you cloned in Intellij
3. Let Intellij build the maven dependencies. 3.1 If Intellij isn't picking this up automatically open pom.xml, click on "Maven" on the right and press the "cycle" icon on the sidebar that has popped up after pressing "Maven".
4. Go to src/main/java/org/um/nine/experiments/ 5.1. RHEA: Go to rhea/ExperimentRunner.java 5.2. MCTS: Go to mcts/ExperimentRunnerMacroMCTS.java 5.3. Hybrid: Go to hybrid/ExperimentRunnerHybrid.java
5. press the "Play" button that appear on the left side of the main function.

The experiment will now start and a GUI with a bunch of graphs will appear. You'll see the game analytics of the games that were played here.

Usage

Take a look at the "Show Rules" button when you started the game. (after you configured the game and press the "Start Game" button. or refer the COVID-21 docs, on the top of this read me. Additionally you could also take a look at the Pandemic rules.

Once the game starts you have a menu on the bottom left which you can use to gather information about the players or to select the actions you would want to use. After selecting an action or event to play you select the city you want to execute it on. Dialog boxes may popup asking you for some additional information (such as choosing the disease to cure), or general error messages for invalid moves.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

We only allow contributions from the assigned project group.

Creating A Pull Request

1. Clone the project
2. Create your Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request from your branch to the master branch.
6. Wait for approval from the lead developer.

License

The game code is to not be used in other projects, unless explicit permission has been granted by the developers.

Authors

• Noah - Software Engineer & Bsc DSAI Student - Noah - Lead Developer
• Lorenzo - Bsc DSAI Student - Lorenzo - Developer
• Eric - Bsc DSAI Student - Eric - Developer
• Kai - Bsc DSAI Student - Kai - Developer
• Illian - Bsc DSAI Student - Illian - Developer
• Drago - Bsc DSAI Student - Drago - Developer

Acknowledgements

• Google Guice
• Katharina Schneider
• Chiara Sironi
• Bill Gates
• Steve Jobs
• Linus Torvalds
• Google Guava
• Lemur
• Google Gson

Known Issues

• Event Cards Missing
• There is a 5th player in the config menu visible? (It only adds a new player when you click the ADD button, and when you click on "Add" for player 5 you get an error, thus you only have 4 players) -> Prossible fix: Add check in "Add" function in configuration screen to ensure a 5th player will not be entered (rendered).
• Infection cubes not getting removed visually after treating. (unique identifiers required to fix) -> Possible fix: Instead of using the index of the array for it's naming when rendering, so utilize an identifier (ID) which should not change while it's placed in a city (or not at all throughout the game, your choice). So when rendering it'll take that name instead of the index of an array.
• Actions that can not be used are still used in the Action menu, they should not be available at all. remove them.
• One of the pawns is fully white, this should get the corresponding color to it's role. (I think it's the only role with a custom color)
• Missing GUI elements (due to forced refactor)
• RHEA incomplete implementation
• MCTS implementation missing

Do Not Fix (or fix at very last)

• Dispatcher role missing
• Fullscreen crash
• Overlapping menu items
• Items off-screen with smaller resolutions. (and apparently multiple monitors)
• Lines that go from e.g Tokyo to San Fransisco go across the map, instead of wrapping over edges.
• Settings screen has duplicate resolution options in the dropdown.