Merge remote-tracking branch 'origin/1.20' into 1.20

.github/workflows/build.yml

@@ -8,34 +8,32 @@ on: [pull_request, push]
 
 jobs:
   build:
-    strategy:
-      matrix:
-        # Use these Java versions
-        java: [
-          17,    # Current Java LTS & minimum supported by Minecraft
-          21,    # Current Java LTS
-        ]
-        # and run on both Linux and Windows
-        os: [ubuntu-22.04, windows-2022]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
+      - uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/loom-cache
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            gradle-
       - name: checkout repository
         uses: actions/checkout@v4
       - name: validate gradle wrapper
         uses: gradle/wrapper-validation-action@v1
-      - name: setup jdk ${{ matrix.java }}
+      - name: setup jdk
         uses: actions/setup-java@v4
         with:
-          java-version: ${{ matrix.java }}
+          java-version: 17
           distribution: 'microsoft'
       - name: make gradle wrapper executable
-        if: ${{ runner.os != 'Windows' }}
         run: chmod +x ./gradlew
       - name: build
         run: ./gradlew build
       - name: capture build artifacts
-        if: ${{ runner.os == 'Linux' && matrix.java == '21' }} # Only upload artifacts built from latest java on one OS
         uses: actions/upload-artifact@v3
         with:
           name: Artifacts
-          path: build/libs/
+          path: build/libs/

README.md

@@ -1,9 +1,26 @@
-# Fabric Example Mod
+# Sabotage
+Sabotage is a social deduction game similar to Murder Mystery or Trouble in Terrorist Town  
+It is split between 3 roles, each with their own goals and means of attack or defense: 
 
-## Setup
+### Saboteur
+The bad guy, they have to kill all of the [Innocents](#innocent) and [Detectives](#detective) without being revealed as a Saboteur.  
+Work with other Saboteurs to sneakily kill others without being caught and blend in with the crowd as to not seem suspicious.  
+Saboteurs can see everyone's roles, use this to your advantage. Target [Detectives](#detective) and get an increased reward.  
+Avoid each map's Tester and the [Detective's](#detective) Portable Tester, as that is used to find out a player's role.
 
-For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
+### Detective
+The Detective is a wild card to [Saboteurs](#saboteur) as they are equipped with a Portable Tester that can determine someone's role,
+be careful using this though, as it has limited uses. [Innocents](#innocent) and [Saboteurs](#saboteur) both know who the Detectives are,
+make sure to protect yourself or else you will be targetted.
 
-## License
+### Innocent
+The Innocents work with [Detectives](#detective) to find out and kill all [Saboteurs](#saboteur).  
+Gain the trust of [Detectives](#detective), protect them and use your numbers to ambush and kill [Saboteurs](#saboteur)  
+Use each map's Tester to prove your innocence and to find [Saboteurs](#saboteur).
 
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+---
+Gear up by opening chests, share resources with trusted players, deduct player's roles through various means and win.
+
+## Installation
+This mod requires [Plasmid](https://modrinth.com/mod/plasmid), [Polymer](https://modrinth.com/mod/polymer) and [Fabric API](https://modrinth.com/mod/fabric-api) to work.  
+It is meant to be installed in a Server, installing it on a Client will likely work, but it is not tested and as such I do not recommend doing so.