Create README.md

bonn2 · Dec 24, 2022 · 290b6b6 · 290b6b6
1 parent af3237f
commit 290b6b6
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# BigDoorsPhysics
+
+This plugin aims to add collions to the spigot plugin [BigDoors](https://www.spigotmc.org/resources/big-doors.58669/) through several methods.
+
+## Minecraft Version
+Built and tested on [PaperMC](https://papermc.io) 1.19, may work on older versions but also may not
+
+## The methods
+- Barriers
+  - Locked to minecraft grid
+  - Very solid
+- Shulkers (not implemented)
+  - Allows off grid collisions
+  - More glitchy
+
+ ## How to build
+ 1. Pull the project
+ 2. Create the directory `~/libs/` in the project
+ 3. Add the latest release of [BigDoors](https://www.spigotmc.org/resources/big-doors.58669/) to the newly created folder
+ 4. Run `gradlew build`
+ 5. Plugin will be placed in `~/build/libs`
+