Skip to content

MeiNic/MenschAergereDichNicht

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo of Mensch ärgere Dich nicht

Mensch ärgere Dich nicht is a digital version of the same-named German board game.

Screenshot of the application showing the game board during a round.

Installation

Mensch ärgere Dich nicht currently requires the Java Runtime Environment to be installed on your computer. We might provide native executables in the future.

Go to the latest release of Mensch ärgere Dich nicht and download the .jar file at the bottom of the page. Open a terminal in the same directory as the downloaded file and run:

java -jar <your-jar-file>

Have fun!

Contributing

Thank you very much for your interest in making Mensch ärgere Dich nicht better. If you would like to report a bug, request a feature or have a question, please open an issue here on GitHub.

If you would like to help develop Mensch ärgere Dich nicht, go ahead and fork this repository. See Getting Started with GitHub if you haven't worked with Git and/or GitHub before.

Development

This game uses Maven as a build tool. To build and run the game, use these commands:

mvn compile && java -jar target/MenschAergereDichNicht-*.jar 

Testing

For now the project has a coverage of about 60% of the code base. To run the tests, you can use your build-in IDE function or Maven:

mvn test

We have the goal to increase the test coverage in the future. If you want to help with that, please write tests for the code you are working on. Note that your test must also run in a headless environment, as we use GitHub actions to run the tests on every pull request.

Code Formatting

We use the Google Java Format for formatting the code. To format the code or check if the code is formatted correctly, you can use these commands:

# Check formatting
mvn spotless:check

# Apply formatting
mvn spotless:apply

You find more information about the formatting in the Google Java Style Guide.

Creating a Pull Request

When you have made changes to the code and want them to be merged into the main branch, please create a pull request. Make sure to ...

  • ... format your code correctly,
  • ... run all tests,
  • ... explain the changes you made,
  • ... and reference an issue in the commit description (e.g., "Fixes #123") if applicable.

Note that on your first pull request the GitHub actions will not run automatically, but require a maintainer to start them manually. After that, the actions will run automatically on every pull request.

License

Mensch ärgere Dich nicht is available under the GPL-3.0-or-later license.

Copyright (C) 2023–2025 MeiNic, TastingComb and contributors.

About

Digital Version of the german game "Mensch ärgere dich nicht"

Topics

Resources

License

Stars

Watchers

Forks

Contributors 7