Branulf/command-gui-buttons-revive
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Joseph Garcia 2020-12-30 19:18:22 -06:00
parent c1502cbfa0
commit eafd2a58fa
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,9 +1,15 @@
# Fabric Example Mod
# Command GUI Buttons
## Setup
Command GUI Buttons is a fabric mod for Minecraft that allows users to create custom command buttons on their clients. Users can bring up this menu in-game with the G key, type in the Name and Command they want to create a button for, and press the + to create. It will then show up as a button on their screen to use whenever they want, as the button will automatically type and execute the command they initially entered.
For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
Create buttons for preset chat messages, commands like '/warp home', or anything else that goes in the chat box.
## License
The list of commands are serialized into a JSON format and stored locally on the users’ systems. The mod writes any new commands into the JSON as new buttons are created, and loads the JSON at the start of the game. A local list instance exists for reading and loading the buttons each time, so that file reading is kept to a minimum.
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
## How to Use:
- Bring up the menu in-game with the G key
- Type in the Name and Command you want to save into a button
- Press the + button
Up to 20 buttons are currently supported! More are planned.