Skip to content

Commit 5336133

Browse files
committed
[ci skip]chore: Update README
1 parent 5c84d6a commit 5336133

4 files changed

Lines changed: 21 additions & 10 deletions

File tree

.github/preview/command.png

3.45 MB
Loading

.github/preview/main_page.png

3.46 MB
Loading

.github/preview/message.png

3.45 MB
Loading

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
# Command GUI Buttons
22

3-
>Forked from https://github.com/joseph-garcia/command-gui-buttons
3+
>Fork from https://github.com/joseph-garcia/command-gui-buttons
44
5-
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.
5+
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 execute the command or send chat message they initially entered.
66

7-
![Cmd GUI Demo](https://jangoscreations.com/wp-content/uploads/2020/12/mcss.png)
7+
Create buttons for preset chat messages, commands like `/warp home`, or anything else that goes in the chat box.
88

9-
Create buttons for preset chat messages, commands like '/warp home', or anything else that goes in the chat box.
9+
## Features
1010

11-
## How to Use:
11+
- Unlimited number of buttons
12+
- Multiple commands or chat messages in one button
13+
- Custom order execute commands or send messages
14+
- Search for buttons (**Case sensitive**)
1215

13-
- Bring up the menu in-game with the G key
14-
- Type in the Name and Command you want to save into a button
15-
- Press the + button
16+
![Main Page](./.github/preview/main_page.png)
17+
![Command Edit](./.github/preview/command.png)
18+
![Message Edit](.github/preview/message.png)
1619

17-
Up to 20 buttons are currently supported! More are planned.
20+
## How to Use:
1821

22+
- Bring up the menu in-game with the `G` key
23+
- Type in the Name and Command you want to save into a button
24+
- Press the `+` button
1925

2026
### How It Works
27+
2128
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.
2229

2330
## Development
2431

2532
### Mappings
2633

27-
We are using the **Mojang official** mappings to de-obfuscate Minecraft and insert patches.
34+
We are using the **Mojang official** mappings to de-obfuscate Minecraft and insert patches.
35+
36+
### Plan(s)
37+
38+
- [] Use the `preprocess` to support low Minecraft versions

0 commit comments

Comments
 (0)