diff --git a/README.md b/README.md index 1b5abf9..c0eb6e4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# EnergeticStorage -A SpigotMC plugin that's heavily inspired by Applied Energistics 2 +
+Applied Energistics 2 for your SpigotMC server +
+ +Energetic Storage is a plugin that is heavily inspired by a forge mod named, [Applied Energistics 2](https://www.curseforge.com/minecraft/mc-mods/applied-energistics-2). If you dont know what Applied Energistics 2 is, its a mod that allows the player to store large amounts of items, sometimes hundreds of thousands, in just a few blocks. + +## Items And Blocks: +* 1k, 4k, 16k, and 64k, drives + * The drives are needed to store items. 1k can store 1024 items, 4k can store 4096 and so on (1024 * how many thousand). + * All drives have a type limit set at 128. This means that only 128 different item types can be added to a single drive. + * Can be changed in config. +* ES System + * The ES System is what keeps the drives inside of it and is used to access the items stored on the drives. + * You can trust players into the system, they will have just as much access as you do. + * Only the system owner can trust players. + * Public ES Systems: + * **_Anybody_** will have access to take items from the system. + * Only trusted players and the owner of the system can destroy it. + +## Permissions +* `energeticstorage.*`: Gives all Energetic Storage permissions. +* `energeticstorage.esgive`: Gives permission to give an Energetic Storage item to themselves. +* `energeticstorage.esgive.others`: Gives permission to give an Energetic Storage item to others. +* `energeticstorage.system.open.untrusted`: Gives permission to open an ES System that the player is not trusted on. +* `energeticstorage.system.create`: Gives permission to create an ES System. +* `energeticstorage.system.destroy.untrusted`: Gives permission to destroy a system the player isn't trusted on. + +## Commands +* /esgive [drive/system] [1k, 4k, 16k, 64k] (player) + +## Config: +Config.yml: +```yaml +driveMaxTypes: 128 # Sets the drives max type limit. +``` + +Players.yml is where **_all_** player data is stored. **I would recommend not messing with this file as it will likely cause errors and item loss!** + +## Screenshots +![driveGUI](screenshots/drive.png) + +![systemDrivesGUI](screenshots/drives.png) + +![securitySetPublicGUI](screenshots/setPublic.png) + +![securityTrustPlayerGUI](screenshots/trustPlayer.png) + +![terminal](screenshots/terminal.png) + +![terminalAmount](screenshots/terminalAmount.png); \ No newline at end of file diff --git a/screenshots/drive.png b/screenshots/drive.png new file mode 100644 index 0000000..75a0372 Binary files /dev/null and b/screenshots/drive.png differ diff --git a/screenshots/drives.png b/screenshots/drives.png new file mode 100644 index 0000000..252d29b Binary files /dev/null and b/screenshots/drives.png differ diff --git a/screenshots/setPublic.png b/screenshots/setPublic.png new file mode 100644 index 0000000..411089c Binary files /dev/null and b/screenshots/setPublic.png differ diff --git a/screenshots/terminal.png b/screenshots/terminal.png new file mode 100644 index 0000000..23d2abd Binary files /dev/null and b/screenshots/terminal.png differ diff --git a/screenshots/terminalAmount.png b/screenshots/terminalAmount.png new file mode 100644 index 0000000..b1d9e65 Binary files /dev/null and b/screenshots/terminalAmount.png differ diff --git a/screenshots/trustPlayer.png b/screenshots/trustPlayer.png new file mode 100644 index 0000000..52024d4 Binary files /dev/null and b/screenshots/trustPlayer.png differ