Skip to content

Commit d61c869

Browse files
committed
Updating README
1 parent d4f6210 commit d61c869

File tree

3 files changed

+58
-19
lines changed

3 files changed

+58
-19
lines changed

README.md

Lines changed: 58 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,70 @@
1-
# mcdevtools
2-
> Minecraft Plugin (1.8.8, 1.19)
1+
<h1 align="center">
2+
Minecraft devtools
3+
<br>
4+
<a href="https://github.com/alkanife/alkabot/blob/main/pom.xml">
5+
<img src="https://img.shields.io/badge/Open%20JDK-17-green" alt="JDK 17">
6+
</a>
7+
<a href="https://github.com/alkanife/mcdevtools/blob/main/LICENSE">
8+
<img src="https://img.shields.io/github/license/alkanife/mcdevtools" alt="LICENSE">
9+
</a>
10+
<a href="https://github.com/alkanife/mcdevtools/releases/tag/2.0.0">
11+
<img src="https://img.shields.io/badge/version-2.0.0-blue" alt="Version 2.0.0">
12+
</a>
13+
<img src="https://img.shields.io/badge/Spigot-1.8.8-orange" alt="Spigot 1.8.8">
14+
<img src="https://img.shields.io/badge/PaperMC-1.20-orange" alt="PaperMC 1.20">
15+
</h1>
316

4-
This plugin helps me to see how colored messages and items would render in Minecraft. Particularly useful when creating custom inventories and Minecraft minigames.
17+
<p align="center">
18+
<a href="#overview">Overview</a>
19+
20+
<a href="#commands">Commands</a>
21+
22+
<a href="#license">License</a>
23+
</p>
24+
25+
## Overview
26+
This plugin mostly helps me to see how colored messages and items would render in Minecraft. It's particularly useful when creating custom inventories and Minecraft minigames. Over time I added a few other commands, see the complete list below.
27+
28+
A version for Minecraft 1.8 is still available under the name **mcdevtools-legacy**, but will not receive the 2.0.0 update. <a href="https://github.com/alkanife/mcdevtools/releases/tag/1.0.0">Latest 1.8-compatible version here</a>.
29+
30+
### Preview
31+
*Echo:*
32+
![echo command](./img/echo.png)
33+
34+
*Item name & lore:*
35+
![item name and lore](./img/item.png)
536

637
## Commands
7-
`/echo` - Broadcast the input
38+
If you are not familiar with the MiniMessage format, go to the documentation by <a href="https://docs.advntr.dev/minimessage/format.html">clicking here</a>.
39+
40+
Chat:
41+
- `echo <value>`: Broadcasts input
842

9-
![Echo command image 1](https://share.alkanife.fr/github/mcdevtools/echo1.png)
10-
![Echo command image 2](https://share.alkanife.fr/github/mcdevtools/echo2.png)
43+
Tablist:
44+
- `tablist_header <value>`: Changes the player list header
45+
- `tablist_footer <value>`: Changes the player list footer
1146

12-
`/rename` - Quickly rename an item (requires to be a player)
47+
Player:
48+
- `player_fly [player]`: Toggle player flight
1349

14-
![Rename command image 1](https://share.alkanife.fr/github/mcdevtools/rename1.png)
15-
![Rename command image 2](https://share.alkanife.fr/github/mcdevtools/rename2.png)
50+
Player's name:
51+
- `player_displayname <player> <value>`: Changes the player's display name
52+
- `player_customname <player> <value>`: Changes the player's custom name
53+
- `player_listname <player> <value>`: Changes the player's list name
1654

17-
`/lore` - Quickly set a lore to an item (`-n` to skip line). If executed by console, this applies to the first connected player
55+
Player's team:
56+
- `player_team_prefix <player> <value>`: Changes the player's team prefix
57+
- `player_team_suffix <player> <value>`: Changes the player's team suffix
58+
- `player_team_color <player> <value>`: Changes the player's team color
1859

19-
![Lore command image 1](https://share.alkanife.fr/github/mcdevtools/lore1.png)
20-
![Lore command image 2](https://share.alkanife.fr/github/mcdevtools/lore2.png)
60+
If the player does not have a team, the command will create one.
2161

22-
## Changes in 1.19+
23-
- Requires [CommandAPI](https://github.com/JorelAli/CommandAPI).
24-
- Inputs are [MiniMessages](https://docs.adventure.kyori.net/minimessage/format.html) for item names and lore.
25-
- Rename and lore commands now requires the player to be specified.
26-
- The `/echo` command works the same way, but a new command (`/echominimessage`) has been added for minimessages.
62+
Items:
63+
- `item_name <player> <value>`: Changes the name of the item the player is holding
64+
- `item_lore <player> <value>`: Changes the lore of the item the player is holding
65+
- `item_lore_at <player> <line> <value>`: Changes the lore of the item the player is holding, specifying which line to change
2766

28-
![Changes in 1.19+](https://share.alkanife.fr/github/mcdevtools/1.19.png)
67+
For the lore, use `<newline>` to skip a line.
2968

3069
## License
31-
[The Unlicense](https://unlicense.org/)
70+
[The Unlicense](https://unlicense.org/)

img/echo.png

413 KB
Loading

img/item.png

991 KB
Loading

0 commit comments

Comments
 (0)