aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranhgelus <anhgelus.morhtuuzh@proton.me>2024-08-21 23:48:25 +0000
committeranhgelus <anhgelus.morhtuuzh@proton.me>2024-08-21 23:48:25 +0000
commitbb50a0190ea416ab066f534401106b3a427d508e (patch)
tree931af3427a61cb6f95c41b1a88651251f21979f3
parentc6de777f621a01f569adbe8b5be6a253131ec299 (diff)
docs(info): add readme
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..64d30e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Molehunt
+
+Molehunt is a Minecraft mod creating the game with the same name in this cubic game.
+
+## Usage
+
+Install the mod on the server and on all clients.
+
+Install Simple Voice Chat.
+
+Start the game with `/molehunt start` and enjoy!
+
+## Features
+
+Every player has the same skin.
+
+Players' nametag are disabled.
+
+The tab, the chat and all message commands (`/msg`, `/tell` and `/w`) are disabled.
+
+Death and advancement messages are disabled.
+
+Stop the game when every innocent is dead or when the timer ended (one hour and half).
+
+The moles can see the name of other moles with `/molehunt moles`.
+
+## Technologies
+
+- Java 1.21
+- Fabric + Fabric API
+- Minecraft with Yarn Mappings