Skip to content

NuanRMxi-Lazy-Team/CustomToast

Repository files navigation

Custom Toast

A Fabric mod that allows players and server administrators to create custom toasts (notifications) in Minecraft.

Features

  • Custom Toast System: Create professional-looking toasts using various Minecraft templates.
  • In-Game Command: Use /toast <type> [title] <message> to trigger toasts on the fly.
  • Dynamic Configuration: Customize toast colors and behavior through a user-friendly settings interface.
  • Internationalization: Full support for English, Chinese (Simplified/Traditional), and Japanese.
  • ModMenu & Cloth Config Integration: Seamlessly configure the mod from within the game's mod list.

Usage

Command Syntax

The mod adds a /toast command with the following syntax:

  • /toast <type> <message>: Displays a toast of the specified type with the message and a default title.
  • /toast <type> <title> <message>: Displays a toast with a custom title and message.

Available Types:

  • info: Blue background, system template.
  • warning: Recipe book background, warning icon.
  • error: Recipe book background, error icon.
  • tutorial: System tutorial template.

Examples

  • /toast info "Hello World"
  • /toast warning "System Alert" "Resources are low!"

Configuration

You can configure the mod using the ModMenu settings or by editing config/customtoast.json.

Available settings:

  • Show Welcome Toast: Toggle the "Welcome" notification when entering the main menu.
  • Enable In-Game Toasts: Global toggle for command-generated toasts.
  • Color Customization: Set specific RGB colors for titles and content for each toast type.

Requirements

  • Minecraft 1.21.1
  • Fabric Loader
  • Fabric API
  • Fabric Language Kotlin
  • Cloth Config API
  • ModMenu (Optional, for settings UI)

License

This mod is licensed under the LGPLv3 license. See the LICENSE file for more details.

About

A mod that allows creating custom toasts via commands and config.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors