Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2retr0/travellerstoasts
Display an informational toast when exploring a new biome!
https://github.com/2retr0/travellerstoasts
fabricmc minecraft
Last synced: about 1 month ago
JSON representation
Display an informational toast when exploring a new biome!
- Host: GitHub
- URL: https://github.com/2retr0/travellerstoasts
- Owner: 2Retr0
- License: mit
- Created: 2022-09-14T19:16:49.000Z (over 2 years ago)
- Default Branch: 1.20
- Last Pushed: 2024-01-15T03:45:05.000Z (about 1 year ago)
- Last Synced: 2024-11-06T13:29:20.049Z (3 months ago)
- Topics: fabricmc, minecraft
- Language: Java
- Homepage: https://modrinth.com/mod/travellerstoasts
- Size: 10.9 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TravellersToasts
Vanilla Minecraft features a plethora of biomes, yet many go overlooked due to visual similarities with other biomes. TravellersToasts is a small mod which aims to better express the personalities of each biome by displaying a *toast*[^1] when you begin '***exploring***' a new biome—take a look!
**·** If you were curious, the shaders used this for demo are [Complementary Shaders](https://www.complementary.dev).
A longstanding issue I've had with vanilla Minecraft is how unrewarding it can feel to visit new biomes. I hope this small addition could help incentivize/reward traveling—if only just a bit more.
## Features (Technical Information)
...Well, the singular feature of this mod fairly evident, so I'll use this section to talk about the various checks in place to ensure biome toasts *only* show *when it makes most sense* (that is, to not just mirror whatever biome the debug screen shows).
* **Movement Checks** *(biome toasts will not be immediately shown when entering a new biome until the player's future position (based on current velocity) remains within said biome for a set amount of time).*
* This prevents biome toasts from showing up when traversing through a biome quickly (e.g. riding a boat on ice).
- **Cooldown Checks** *(a biome toast for a given biome will never show up twice within a configurable cooldown period).*
- This prevents biome toasts from being invoked constantly when crossing the same border often.
* **Location Checks** *(biome toasts will not be shown when underground, unless in a cave biome (e.g. lush caves)).*
* This prevents biome toasts from showing up when—for example—strip mining (as opposed to the default behavior of underground biomes mirroring their surface biomes).
* Additionally, for ocean biomes, toasts will not show if the player is *not* swimming (e.g. riding a boat).
- **Inhabited Time Checks** *(biome toasts will never be shown when entering a chunk with an inhabited time past a \*configurable\* threshold).*
- This prevents biome toasts from showing in bases or commonly explored areas.
- ***Note:*** This feature will not be available on servers which don't have the mod installed!
Summarizing, to begin '***exploring***' a new biome is to enter a biome whilst passing all the above checks (and probably a few more I forgot to list). Thanks for reading!
Download the latest version over at [Modrinth](https://modrinth.com/mod/TravellersToasts)!
[^1]: Icons were scraped from the [Biomes](https://minecraft.fandom.com/wiki/Biome) page on the Minecraft Wiki. I am not sure if they are 'official' but they fit quite nicely!