This repository is a combination of the class library which runs the game, as well as the game server and client libraries.

For additional information on the game server, view the readme in the Server directory.

1. Install a C# IDE like Jetbrains Rider or Visual Studios Community 2019.

2. Once you have installed an IDE, ensure that you have the .NET standard 2.0 framework and .Net Core 5.0.

3. I'm sure if you're here this step is done but, you need to download Git to gain access to the code

4. Fork this repository and get clone the repository.

Note: After cloning the repository you will have the master branch checked out. This is likely not the most recent version of the code. You will want to checkout a branch. Ask in our discord what branch is the most up to date.

5. Using your IDE, open the project's .sln file. This will open the project within your IDE. Once open in the IDE, you are ready to go.

If using the Core dll class libraries, be sure to [View the API Documentation]documentation on the class library's API here to understand how to make use of the API to load a game and parse a game state.

Once you have the project loaded, you should have two folders, each containing a number of projects. Within each project, a Test project is present which is used to validate that the code is running as expected. In order to run the test projects, you can simply right click the test project and click "Run tests in ".

If your IDE does not have the ability to do this, the following command can be executed to run the tests:

dotnet test Core/SubterfugeCoreTest

Additionally note: The SubterfugeServerTest project requires the database to be started. Please see the Server readme for more information on starting the database.