mirror of
https://github.com/JamesPeters98/ChestsPlusPlus.git
synced 2025-01-10 10:27:44 +01:00
Update README.md
This commit is contained in:
parent
455d1392ce
commit
94f813ca1f
73
README.md
73
README.md
@ -3,21 +3,46 @@
|
||||
Minecraft Spigot mod that enhances chests and hoppers, with ChestLinks and Hopper filters!
|
||||
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/zQgesHB.png">
|
||||
<img src="https://i.imgur.com/fFWiH5Y.png">
|
||||
</p>
|
||||
|
||||
If your server is using this plugin let me know so I can feature it!
|
||||
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/T1Cq6t8.png">
|
||||
</p>
|
||||
|
||||
|
||||
## What it does:
|
||||
## Features:
|
||||
- Ability to link multiple chests together across the entire server to be accessed from anywhere!
|
||||
- Use Hoppers to filter items from chests using hoppers!
|
||||
- Setup Auto-Crafting Tables to automatically craft items from the inventory above!
|
||||
- Silk Touch can pick up ChestLinks and AutoCraft stations!
|
||||
- Displays the most common item in a chest on the front of it!
|
||||
- Build cool auto smelting/sorting systems!
|
||||
- Remotely open chests with a nice menu system!
|
||||
|
||||
## How to use:
|
||||
- Add a chest using /chestlink add <group> or simply write the ChestLink format on a sign placed on a chest!
|
||||
## How to Create Linked Chests:
|
||||
- Add a Chest using **/chestlink add** <**group**> or simply write the ChestLink format on a sign placed on a Chest!
|
||||
![](https://i.gyazo.com/5ef24a3833e57bc0b3df230a90d67fb9.png)
|
||||
- Open a chest as you normally would! or use /chestlink open <group> or /chestlink menu to open the chest remotely!
|
||||
- Each chest that gets added to that group will share the same inventory with all other chests in that group!
|
||||
- *Note the **/chestlink** command can be replaced with **/cl** for convenience.*
|
||||
|
||||
## How to Create Auto-Crafting Stations
|
||||
- Add a Crafting Table using **/autocraft add** <**group**> or simply write the AutoCraft format on a sign placed on a Crafting Table!
|
||||
![](https://i.imgur.com/RTeUOvX.png)
|
||||
- Open the Crafting Table and create your recipe (This requires at least one of each item and it won't use that item up!)
|
||||
- Once you have a valid recipe the table will notify you with a chime, at this point if the recipe has different variations such as wood type they will start to animate in the crafting grid.
|
||||
- To start crafting, a Chest (or any block with a valid inventory such as Furnaces, Barrels, Shulker Boxes, Hoppers etc) must be placed either on top or on any of the 3 sides not including the front.
|
||||
- Next, place a hopper underneath the Crafting Table and AutoCrafting will start automatically.
|
||||
- Alternatively, place a Chest or any other inventory block underneath the Crafting Table and apply a redstone signal to it.
|
||||
|
||||
### Torch AutoCraft Example:
|
||||
The following configurations work to AutoCraft torches with either a Hopper, or a chest underneath!
|
||||
![](https://i.imgur.com/fpgNWLy.png)
|
||||
|
||||
|
||||
- Filter chests using Hoppers with Item Frames! Any hopper with an Item Frame on it with an item inside will only pull items of that type! (Note: You can add multiple item frames to a hopper to filter multiple items!)
|
||||
- Build giant smelting and sorting systems and share your creations!
|
||||
|
||||
@ -34,6 +59,7 @@ If your server is using this plugin let me know so I can feature it!
|
||||
![Inventory Menu](https://i.imgur.com/StpFBYm.png)
|
||||
|
||||
## Commands:
|
||||
#### ChestLink Commands - **/chestlink** or **/cl** are accepted.
|
||||
|
||||
- /chestlink add <Group> "Create/add a chest to a ChestLink group"
|
||||
- /chestlink remove <Group> "Delete a ChestLink and drop its inventory at your feet!"
|
||||
@ -42,10 +68,21 @@ If your server is using this plugin let me know so I can feature it!
|
||||
- /chestlink help "List of commands and their uses!"
|
||||
- /chestlink list "Lists all ChestLinks that you own!"
|
||||
- /chestlink member [add/remove <group> <player>] or [list <group>] "Add, remove or list members of a group"
|
||||
- /chestlink member [add-to-all/remove-from-all] "Add/Remove a player to all of your ChestLinks"
|
||||
- /chestlink setpublic <group> <true/false> "Set a ChestLink to be accessible by anyone."
|
||||
- /chestlink rename <group> <new-name> "Rename a ChestLink."
|
||||
- /chestlink sort <group> <sort-method> "Set the sorting option for the given ChestLink."
|
||||
|
||||
- /autocraft add <Group> "Create/add a Crafting Table to an AutoCraft group"
|
||||
- /autocraft remove <Group> "Delete an AutoCraft group and drop all the Crafting Tables!"
|
||||
- /autocraft open <Group> "Open the workbench of an AutoCraft group"
|
||||
- /autocraft help "List of commands and their uses!"
|
||||
- /autocraft list "Lists all AutoCraft groups that you own!"
|
||||
- /autocraft member [add/remove <group> <player>] or [list <group>] "Add, remove or list members of a group"
|
||||
- /autocraft member [add-to-all/remove-from-all] "Add/Remove a player to all of your AutoCraft groups"
|
||||
- /autocraft setpublic <group> <true/false> "Set an AutoCraft group to be accessible by anyone."
|
||||
- /autocraft rename <group> <new-name> ""Rename an AutoCraft group."
|
||||
|
||||
## Spotlights:
|
||||
|
||||
[![](http://img.youtube.com/vi/a1MvNNEe8NM/0.jpg)](http://www.youtube.com/watch?v=a1MvNNEe8NM "Spotlight")
|
||||
@ -87,8 +124,8 @@ default: true
|
||||
|
||||
```yaml
|
||||
chestlink.openall:
|
||||
description: Gives permission to open all chests, for admin use.
|
||||
default: false
|
||||
description: Gives permission to open all chests/autocraft stations, for admin use.
|
||||
default: op
|
||||
```
|
||||
|
||||
```yaml
|
||||
@ -96,6 +133,30 @@ chestlink.member:
|
||||
description: Gives permission to add/remove a member to/from their chestlink.
|
||||
default: true
|
||||
```
|
||||
|
||||
```yaml
|
||||
chestlink.sort:
|
||||
description: Gives permission to sort ChestLinks.
|
||||
default: true
|
||||
```
|
||||
|
||||
```yaml
|
||||
chestlink.autocraft.add:
|
||||
Gives permission to add AutoCraft Stations!
|
||||
default: true
|
||||
```
|
||||
|
||||
```yaml
|
||||
chestlink.autocraft.open:
|
||||
Gives permission to open AutoCraft Stations!
|
||||
default: true
|
||||
```
|
||||
|
||||
```yaml
|
||||
chestlink.autocraft.remove:
|
||||
Gives permission to remove AutoCraft Stations!
|
||||
default: true
|
||||
```
|
||||
|
||||
# Donate!:
|
||||
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4BCPAVJ7PBUUY&source=url
|
||||
|
Loading…
Reference in New Issue
Block a user