potrogue/README.md

11 lines
785 B
Markdown
Raw Normal View History

2023-10-28 19:54:38 -06:00
# PotRogue
2023-10-28 21:09:10 -06:00
### A WIP, opensource, roguelike project built in [Kotlin](https://kotlinlang.org/), utilizing [Zircon](https://hexworks.org/projects/zircon/).
2023-10-30 11:23:31 -06:00
### For now, please make issues on [The mirror repo](https://next.forgejo.org/Ouroboros/potrogue/issues) as ForgeFed has not yet been implemented in mainline ForgeJo, and this instance does not have an open registration
2023-10-27 01:33:00 -06:00
2023-10-30 01:56:29 -06:00
## Installation
1. Make sure you have installed Java 20/21
2023-11-01 03:28:04 -06:00
2. Clone this repo and run `./gradlew clean build` || ~~Download the latest .jar in the Releases page [Self-Hosted ForgeJo](https://git.ouroboros.group/Ouroboros/potrogue/releases) | ~~[Mirror](https://next.forgejo.org/Ouroboros/potrogue/releases)~~~~
2023-11-01 03:29:15 -06:00
3. Navigate to the `build/libs` directory, and run the jar (make sure its executable!)
2023-10-30 01:56:29 -06:00
4. Enjoy!