Skip to content

Commit d8c8f1e

Browse files
authored
Update README.md
1 parent ab97121 commit d8c8f1e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# TuffXPlugin
1+
# TuffX
2+
3+
![preview](https://raw.githubusercontent.com/TuffNetwork/TuffX-Plugin/refs/heads/main/img/showcase.png)
4+
:-:
5+
TuffX allowing players to see and beat a trial chamber.
6+
7+
> [!WARNING]
8+
> This is not a "crack" for Minecraft, it simply allows for better TuffClient integration on servers.
9+
10+
## Quick Start
11+
Install the latest jar from [releases](https://github.com/TuffNetwork/TuffX-Plugin/releases/latest/) into your server's `plugins` folder. Then, restart your server, and join via TuffClient. You should now be able to use extra features such as below y0 and ViaBlocks!
12+
13+
## Compiling
14+
```sh
15+
$ git clone https://github.com/TuffNetwork/TuffX-Plugin
16+
$ cd TuffX-Plugin
17+
$ mvn clean install
18+
```
19+
20+
The built plugin jar will be in the `target` folder.

0 commit comments

Comments
 (0)