Skip to content

Commit 2c9f60d

Browse files
MSDNicrosoftMSDNicrosoft
committed
docs: Make it more user-friendly
1 parent 69a619a commit 2c9f60d

2 files changed

Lines changed: 51 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,35 @@
88

99
> Fork from https://github.com/joseph-garcia/command-gui-buttons
1010
11+
[![Last build](https://img.shields.io/github/actions/workflow/status/MSDNicrosoft/Command-GUI-Buttons/Build.yml?label=Last%20build&style=flat-square)](https://github.com/Hendrix-Shen/Tweak-My-Client/actions/workflows/CI.yml)
12+
[![Github Release](https://img.shields.io/github/v/release/MSDNicrosoft/Command-GUI-Buttons?label=Github%20Release&style=flat-square)](https://github.com/Hendrix-Shen/Tweak-My-Client/releases)
13+
14+
## Description
15+
1116
Command GUI Buttons is a fabric mod for Minecraft that allows users to create custom command buttons on their clients.
12-
Users can bring up this menu in-game with the <kbd>G</kbd> key, type in the button's Name and Command they want to create, and
13-
press the `+` to create. It will then show up as a button on their screen to use whenever they want.
17+
Users can bring up this menu in-game with the <kbd>G</kbd> key, type in the button's Name and Command they want to
18+
create, and press the `+` to create. It will then show up as a button on their screen to use whenever they want.
1419

1520
Create buttons for preset chat messages, commands like `/warp home`, or anything else that goes in the chat box.
1621

22+
## Dependencies
23+
24+
| Dependency | Type | Link |
25+
|------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
26+
| Fabric API | Required | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api) \| [Modrinth](https://modrinth.com/mod/fabric-api/) |
27+
| LibGui | Required | [GitHub](https://github.com/CottonMC/LibGui/releases) \| [Maven(Not recommend)](https://server.bbkr.space/artifactory/libs-release/io/github/cottonmc/LibGui/) |
28+
29+
For your convenience, download links are listed below:
30+
31+
| Minecraft Version | Fabric API | LibGui (**Please use the given version**) |
32+
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
33+
| 1.16.5 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.16.5) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.16.5) | 3.4.0 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/3.4.0) |
34+
| 1.17.1 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.17.1) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.17.1) | 4.2.3 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/4.2.3) |
35+
| 1.18.2 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.18.2) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.18.2) | 5.4.2 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/5.4.2) |
36+
| 1.19 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19) | 6.4.0 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/6.4.0) |
37+
| 1.19.3 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19.3) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19.3) | 6.5.3 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/6.5.3) |
38+
| 1.19.4 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19.4) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19.4) | 7.0.0-rc1 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/7.0.0-rc.1) |
39+
1740
## Features
1841

1942
- Unlimited number of buttons
@@ -25,7 +48,7 @@ Create buttons for preset chat messages, commands like `/warp home`, or anything
2548
![Command Edit](./.github/preview/command.png)
2649
![Message Edit](.github/preview/message.png)
2750

28-
## How to Use:
51+
## How to Use
2952

3053
- Bring up the menu in-game with the <kbd>G</kbd> key
3154
- Type in the Name and Command you want to save into a button

‎README_ZH_CN.md‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,39 @@
11
<div align="right">
2-
简体中文
3-
|
42
<a title="English" href="./README.md">English</a>
5-
</div>
3+
|
4+
简体中文
5+
</div>>
66

77
# Command GUI Buttons
88

99
> 复刻自 https://github.com/joseph-garcia/command-gui-buttons
1010
11+
## 描述
12+
1113
Command GUI Buttons 是 Minecraft 的 Fabric 模组，允许用户在其客户端上创建自定义命令按钮。
1214
用户可以在游戏中使用 <kbd>G</kbd> 键调出此菜单，输入他们想要为其创建按钮的名称和命令。
1315
完成之后，相关内容将在屏幕上显示为数个按钮，以便随时使用。
1416

1517
为预设的聊天消息、`/warp home` 等命令，或聊天框中的任何内容创建按钮。
1618

19+
## 依赖
20+
21+
| 依赖 | 类型 | 链接 |
22+
|------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
23+
| Fabric API | 必须 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api) \| [Modrinth](https://modrinth.com/mod/fabric-api/) |
24+
| LibGui | 必须 | [GitHub](https://github.com/CottonMC/LibGui/releases) \| [Maven(Not recommend)](https://server.bbkr.space/artifactory/libs-release/io/github/cottonmc/LibGui/) |
25+
26+
为了方便，下方已列出下载链接：
27+
28+
| Minecraft 版本 | Fabric API | LibGui (**请使用给定的版本**) |
29+
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
30+
| 1.16.5 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.16.5) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.16.5) | 3.4.0 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/3.4.0) |
31+
| 1.17.1 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.17.1) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.17.1) | 4.2.3 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/4.2.3) |
32+
| 1.18.2 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.18.2) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.18.2) | 5.4.2 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/5.4.2) |
33+
| 1.19 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19) | 6.4.0 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/6.4.0) |
34+
| 1.19.3 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19.3) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19.3) | 6.5.3 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/6.5.3) |
35+
| 1.19.4 | [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files?version=1.19.4) \| [Modrinth](https://modrinth.com/mod/fabric-api/versions?g=1.19.4) | 7.0.0-rc1 [GitHub](https://github.com/CottonMC/LibGui/releases/tag/7.0.0-rc.1) |
36+
1737
## 功能
1838

1939
- 无限制数量的按钮
@@ -25,7 +45,7 @@ Command GUI Buttons 是 Minecraft 的 Fabric 模组，允许用户在其客户
2545
![Command Edit](./.github/preview/command.png)
2646
![Message Edit](.github/preview/message.png)
2747

28-
## 如何使用:
48+
## 如何使用
2949

3050
- 使用 <kbd>G</kbd> 键调出游戏内的菜单
3151
- 键入要保存的按钮名称及其命令
@@ -38,7 +58,7 @@ Command GUI Buttons 是 Minecraft 的 Fabric 模组，允许用户在其客户
3858

3959
## 开发
4060

41-
## 支持
61+
### 支持
4262

4363
当前主开发版本: `1.19.4`
4464

0 commit comments

Comments
 (0)