Tweak README

This commit is contained in:
Johannes Frohnmeyer 2022-03-13 17:13:53 +01:00
parent 834bc06cc2
commit 0b3323fb9c
Signed by: Johannes
GPG Key ID: E76429612C2929F4
1 changed files with 4 additions and 4 deletions

View File

@ -1,8 +1,8 @@
# BreakMe [![pipeline status](https://gitlab.com/jfmods/BreakMe/badges/master/pipeline.svg)](https://gitlab.com/jfmods/BreakMe/-/commits/master)
BreakMe crashes Minecraft in creative ways. It uses Fabric (although porting should be trivial, most of the code is standard java & some JNI)\
BreakMe allows configuring an event (death/taking damage) that causes minecraft to crash. It can also be configured to shut down or crash the whole OS.
It uses Fabric (although porting should be trivial, most of the code is standard java & some JNI)
# Installing
I recommend you to use the automatically built packages, you can download the latest curseforge build [here](https://gitlab.com/jfmods/BreakMe/-/jobs/artifacts/master/raw/latest-cf.jar?job=build_test) and the latest non-cf build [here](https://gitlab.com/jfmods/BreakMe/-/jobs/artifacts/master/raw/latest.jar?job=build_test)
Please note that shutting down (or worse: crashing) an OS while things are still open might cause data loss,
I am not responsible for that if you decide to enable that setting
# Configuration
You can use [Mod Menu](https://www.curseforge.com/minecraft/mc-mods/modmenu) to change the configuration.\