Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kikugie committed Jul 27, 2024
1 parent 2ce8c7c commit aece2d9
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,28 @@
Have you ever played with a proximity voice chat mod and thought "Damn, I miss dropping a metal pipe sound effect in my Discord calls"?
**Well, look no further! Since now you can do it in Minecraft!**

## How to use
Sounds are stored in `.minecraft/config/soundboard`, where you can put files and create directories to organize the files.
**Files must be in `.wav` format. Use an online audio converter if needed.**
## Addons
This mod is split for Simple Voice Chat and Plasmo Voice. Use links below to navigate to the correct one:

The soundboard screen can be opened with **J**:
![Soundboard screen](https://cdn.modrinth.com/data/N8s60DWW/images/3a0dc4edbe8dedd4ece49b635e2f38d097470b37.png)
| Simple Voice Chat | [Modrinth](https://modrinth.com/mod/voicechat-soundboard) | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/voicechat-soundboard) |
|-------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------|
| Plasmo Voice | [Modrinth](https://modrinth.com/mod/plasmo-soundboard) | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/plasmo-voice-soundboard) |

## Dependencies
This mod requires:
- [Fabric API](https://modrinth.com/mod/fabric-api)
- [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin)
- [OwO Lib](https://modrinth.com/mod/owo-lib)

The mod consists of 2 variations, which support the following mods:
- [Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat)
- [Plasmo Voice](https://modrinth.com/plugin/plasmo-voice)
## How to use
Sounds are stored in `.minecraft/config/soundboard`, where you can put files and create directories to organize the files.
**Files must be in `.wav` format. Use an online audio converter if needed.**

The soundboard screen can be opened with **J**:
![Soundboard screen](https://cdn.modrinth.com/data/N8s60DWW/images/3a0dc4edbe8dedd4ece49b635e2f38d097470b37.png)

Refer to the [changelog](https://modrinth.com/mod/voicechat-soundboard/changelog) for more information.

## Development
This is a barebones release of the mod, and I'm planning to expand its features with a config, favorite sounds, audio editing and other cool stuff.
I'm planning to expand its features with a config, favorite sounds and other cool stuff.
If you have suggestion or issues tell me on the [Discord server](https://discord.gg/TBgNUCfryS) or [GitHub issues](https://github.com/kikugie/voicechat-soundboard).

0 comments on commit aece2d9

Please sign in to comment.