Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zlfn authored Feb 16, 2022
1 parent 52269b4 commit d56fa7f
Showing 1 changed file with 39 additions and 7 deletions.
46 changes: 39 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,48 @@
![Logo](./image/tritonelogo.jpg)

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

**This mod is currently under development and not yet available!!**
**This mod is currently in beta! There may be bugs.**

## Why not use this?
* There are many other Minecraft prioxity voice chat modes.
## Why not use this?
* There are many other Minecraft prioximity voice chat modes.
* Due to the limitations of Discord, 3D sound is not supported.
## Why use this?
## Why use this?
* Tritone **does not** require any configuration on the server side. so, you can use Tritone on any public server in Minecraft.
* Discord's voice chat has better sound quality than other modes.
* Discord's voice chat has better sound quality than other mods.
* Setting up this mod is very, very easy.
## ❓How to use?
### 🚀installation
This mod currently supports windows forge 1.16.5 only. (Linux soon. MacOS somedays..)<br>
Just unzip the release zip file on your minecraft mods directory.<br>
**You must have a logged-in Discord installed on your computer.**
### ✏Basic Use
After installing this mod and entering the multiplayer server, you will automatically be able to prioximity voice chat.<br>
* 'I' key makes you inaudible.
* 'M' key for mute yourself.
### ✒Advanced Use
You can custom mod's discord applicationID and default lobby name via editing config.json <br>
This prevents voice chatting with unwanted people.
* clientID : Client ID issued by Discord developer site
* lobbyname : An alternative for those who are bothered by getting a clientID

**It must have the same clientID and same lobbyname as the person you want to talk to.**
## 🚩Roadmap
### InProgress
* GUI
* Forge 1.12 support
* Linux support
### Planned
* Forge 1.18 support
* Separation of lobbies by server
* MacOS support
* Multiple language support
### Someday...
* Fabric support
* Forge 1.19+ support

## For development...
* We used Rust JNI for on-JVM use of discord-game-sdk.
* Before building this project, you need some setup...
Expand Down

0 comments on commit d56fa7f

Please sign in to comment.