diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a9d7de --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +<div align="center"> + <img src="assets/sprites/brand.png" alt="Maxon Petting Simulator" title="Maxon Petting Simulator"><hr> + <a href="https://wakatime.com/badge/user/09f67b1c-0691-482a-a1d4-e4751e6962de/project/79913770-2bc1-448e-91e8-5bef19d4622d"><img src="https://wakatime.com/badge/user/09f67b1c-0691-482a-a1d4-e4751e6962de/project/79913770-2bc1-448e-91e8-5bef19d4622d.svg?style=plastic" alt="wakatime"></a> + <img src="https://img.shields.io/github/license/notdankenough/MaxonPettingSim?style=plastic"> + <a href="https://ilotterytea.itch.io/maxon"><img src="https://img.shields.io/badge/-Get%20the%20Maxon%20Petting%20Simulator%20on%20Itch.io-171601?style=plastic&logo=itch.io"></a> +</div> + +# Maxon Petting Simulator (Open-Source) +Maxon Petting Simulator source code release. The game is built in Java and uses LibGDX as the main game framework. It is built using Gradle. + +> If you have any questions or issues, submit them on [Issues](https://github.com/notdankenough/maxonpettingsim/issues)! + +## Building +To compile this project you will need [JDK 17](https://adoptium.net/). Copy the repository and open it via the terminal and do what you need: +### Game (For desktop): +*Running*: `./gradlew desktop:run`<br> +*Building*: `./gradlew desktop:dist` + +## License +This project is under the Mozilla Public License 2.0! [Read on LICENSE](https://github.com/NotDankEnough/MaxonPettingSim/blob/master/LICENSE).<br> +Project Assets under the [Creative Commons Attribution v4.0 International](https://creativecommons.org/licenses/by/4.0/)!
\ No newline at end of file |