Skip to content

Commit d56fa7f

Browse files
authored
Update README.md
1 parent 52269b4 commit d56fa7f

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,48 @@
11
![Logo](./image/tritonelogo.jpg)
22

3-
# TRITONE
4-
**Minecraft Client side in-game prioxity voice chatting via discord**
3+
# 🔉TRITONE
4+
**Minecraft in-game prioximity voice chatting mod via discord-game-sdk.**<br>
5+
This README.md was written by a non-English speaking person, so it might be awkward. Help us with PR!
56

6-
**This mod is currently under development and not yet available!!**
7+
**This mod is currently in beta! There may be bugs.**
78

8-
## Why not use this?
9-
* There are many other Minecraft prioxity voice chat modes.
9+
## Why not use this?
10+
* There are many other Minecraft prioximity voice chat modes.
1011
* Due to the limitations of Discord, 3D sound is not supported.
11-
## Why use this?
12+
## Why use this?
1213
* Tritone **does not** require any configuration on the server side. so, you can use Tritone on any public server in Minecraft.
13-
* Discord's voice chat has better sound quality than other modes.
14+
* Discord's voice chat has better sound quality than other mods.
15+
* Setting up this mod is very, very easy.
16+
## ❓How to use?
17+
### 🚀installation
18+
This mod currently supports windows forge 1.16.5 only. (Linux soon. MacOS somedays..)<br>
19+
Just unzip the release zip file on your minecraft mods directory.<br>
20+
**You must have a logged-in Discord installed on your computer.**
21+
### ✏Basic Use
22+
After installing this mod and entering the multiplayer server, you will automatically be able to prioximity voice chat.<br>
23+
* 'I' key makes you inaudible.
24+
* 'M' key for mute yourself.
25+
### ✒Advanced Use
26+
You can custom mod's discord applicationID and default lobby name via editing config.json <br>
27+
This prevents voice chatting with unwanted people.
28+
* clientID : Client ID issued by Discord developer site
29+
* lobbyname : An alternative for those who are bothered by getting a clientID
30+
31+
**It must have the same clientID and same lobbyname as the person you want to talk to.**
32+
## 🚩Roadmap
33+
### InProgress
34+
* GUI
35+
* Forge 1.12 support
36+
* Linux support
37+
### Planned
38+
* Forge 1.18 support
39+
* Separation of lobbies by server
40+
* MacOS support
41+
* Multiple language support
42+
### Someday...
43+
* Fabric support
44+
* Forge 1.19+ support
45+
1446
## For development...
1547
* We used Rust JNI for on-JVM use of discord-game-sdk.
1648
* Before building this project, you need some setup...

0 commit comments

Comments
 (0)