Add README.md

2022-05-30 23:55:44 +02:00 · 2022-05-30 23:55:44 +02:00 · 27e0acf868
commit 27e0acf868
parent 4005f2d968
1 changed files with 24 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,24 @@
+# LaserGun Plugin
+
+This is a very basic Spigot plugin that adds a laser gun in Minecraft.
+**The plugin depends on [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)**.
+
+## Commands
+- /lasergun: see basic plugin info.
+- /lasergun help: see the commands list.
+- /lasergun get: add the gun to your inventory!
+- /lasergun reload: reload the config.
+
+##Permissions
+- lasergun.command.getgun: get the gun!
+- lasergun.usegun: fire the gun!
+- lasergun.command.reload: reload the config.
+- lasergun.updates: get updates notifications.
+
+##Config
+```yaml
+radius: 10 # maximum shooting range
+damage: 6.0 # lasergun projectile damage
+sound: true # play a sound when shooting?
+update-checker: true # enable updates checking?
+```