https://github.com/kessokuteatime/splasher

[Minecraft Mod] Why don't splash? Splasher is a mod which makes splash texts fully customizable.
https://github.com/kessokuteatime/splasher

fabricmc forge-mod minecraft minecraft-fabric minecraftforge neoforge-mod neoforged rust

Last synced: 3 months ago
JSON representation

[Minecraft Mod] Why don't splash? Splasher is a mod which makes splash texts fully customizable.

• Host: GitHub
• URL: https://github.com/kessokuteatime/splasher
• Owner: KessokuTeaTime
• License: gpl-3.0
• Created: 2022-08-27T10:09:28.000Z (over 2 years ago)
• Default Branch: fabric/1.21
• Last Pushed: 2024-07-18T10:01:39.000Z (6 months ago)
• Last Synced: 2024-10-14T06:22:28.206Z (3 months ago)
• Topics: fabricmc, forge-mod, minecraft, minecraft-fabric, minecraftforge, neoforge-mod, neoforged, rust
• Language: Java
• Homepage: https://modrinth.com/mod/splasher
• Size: 11.4 MB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### 
[`→` CurseForge](https://www.curseforge.com/minecraft/mc-mods/splasher) [`→` Modrinth](https://modrinth.com/mod/splasher)


![Banner](https://github.com/KessokuTeaTime/Splasher/blob/artwork/banner.png)

**Customize Minecraft's Splash Texts at Your Will!**

## Contributing a Translation

Splasher turns Minecraft `splashes.txt` into `.json` files, and supports multi languages.

You will find `en_us.json` under `assets/splasher/lang/` and feel free translate it into your favorite language.

After translation, rename it to `xx_xx.json` (e.g., `zh_cn.json`), and enjoy! You can also create a pull request to contribute.

## Adding a Customization

Splasher supports custom splash texts to append, or replace the original ones.

Custom splash texts are `.txt` files stored under `.minecraft/config/splasher/` and should be named the same as your target language (`en_us.txt` etc.).

In these files, every single splash takes a single line, and `§ Formatting Code` is under supported, the same as the Minecraft `splashes.txt` under directory `.minecraft/assets/minecraft/texts/`.

## Configuring Splasher

Splasher is using **[Cloth Config API](https://modrinth.com/mod/cloth-config)** and is fully configurable, you can find the config file under `.minecraft/config/splasher.toml`.

Every option is well documented, and you can achieve different effects by changing the values, for example:

- Disabling all splashes

- Only enabling custom splashes

- Enabling both original and custom splashes, and not following the client language

- And more...

## License

**Splasher** is licensed under the **[GNU General Public License v3.](LICENSE)**

## Screenshots

> ![Custom Splash Text](https://github.com/KessokuTeaTime/Splasher/blob/artwork/content/splash.png)

>

> Splasher displaying custom splash text `Splasher!`