Gentle Reminders

Gentle Reminders is a mod that sends mindful messages to the player every so often based on a customizable config file.
Available for download on Curseforge and Modrinth. Thank you for over 1800 downloads!

Version Support

Gentle Reminders supports multiple Minecraft versions and mod loaders:

Features

• Multi-version and multi-loader support: Works on Fabric and NeoForge across multiple Minecraft versions (see Version Support table above)
• Generates a config file on client startup if one doesn't exist
• Checks version of config file to guarantee latest message updates
• Client reads from config file to get settings
• On world join, sends an initial message if the mod is enabled
• Every X ticks, based on config, sends a mindful message
• When all messages are sent (in a random order with no repeats), resets the list and starts over
• Customizable toasts with block textures as the background and border!
• Config persistence: Custom display style settings (background texture, border texture, icon) are automatically saved to the config file when changed via commands
• All config values are automatically saved when modified through commands
• Config Guide below
• Commands Guide below

Version Compatibility & Known Limitations

Icon Support

• Fabric 1.20.1: Custom display style icons (exclamation mark) are not supported due to API limitations in this Minecraft version. Icons will not appear even if customIncludeIcon is set to true.
• Fabric 1.21.1+: Icons are fully supported.
• NeoForge (all versions): Icons are fully supported.

Feature Parity

• Fabric vs NeoForge: Both loaders have full feature parity except for the icon limitation in Fabric 1.20.1. All commands, display styles, and config features work identically across both loaders.

Upcoming Features

• Add a drastically large amount of messages
  • Current # of simple messages: 34
  • Current # of unique/special messages: 62
• Add support for modded blocks to be used as the background/border
• Add custom message icons (not just an exclamation!)
• Make a cool GUI to edit custom toasts

Message Examples

Simple Message (Default Style)

Unique Message (Dark Style)

Unique Message (Light Style)

Unique Message (Chat Style)

Custom Dark Oak Planks Background and Amethyst Block Border

Custom Blackstone Background and Resin Brick Border

Custom Redstone Block Background and Diorite Border

Custom Slime Block Background and Sand Border

How it shows up in-game

Config Guide

The config file can be found at config/gentlereminders-config.toml (after running the game once), which can be edited with any text editor. You can change the values for the interval between messages, add or remove messages, and enable or disable the mod.

Adding messages should be done in the following format:

  {id=#, title="String", message="String", enabled=boolean, titleColor="String", messageColor="String"},

• id is a whole number that should be unique between messages
• title is the title of the message that will be displayed at the top of the toast
  
  • Important Note: This title can not include a comma (,) or the config file will break
• message is the message that will be displayed in the body of the toast
  • Important Note: This message can not include a comma (,) or the config file will break
• enabled is a boolean that determines if the message can be sent - if you're setting to false anyway, you can also just remove the message unless you think you'll want to re-enable it later
• titleColor is a string that represents the color of the title text, which can be any of the colors below:
• messageColor is a string that represents the color of the message text, which can be any of the colors below:

 "black", "dark_blue", "dark_green", "dark_aqua", "dark_red", "dark_purple", "gold", "gray", "dark_gray", "blue", "green", "aqua", "red", "light_purple", "yellow", "white"

Command Guide

Required arguments are surrounded by [brackets]

/gentlereminders and /gentlereminders help

• Displays the help message

/gentlereminders get TimeRemaining

• Displays the time remaining until the next message is sent

/gentlereminders get ConfigPath

• Displays the path to the config file

/gentlereminders get ConfigVersion

• Displays the version of the config file

/gentlereminders get DisplayStyle

• Displays the current display style

/gentlereminders get TicksBetweenMessages

• Displays the number of ticks between messages, as well as minutes and seconds

/gentlereminders get Messages [pageNumber]

• Displays 5 messages at a time, starting at the page number specified

/gentlereminders set DisplayStyle [style]

• Sets the display style to either "default", "light", "dark", or "chat" (use the below command for custom)

/gentlereminders set CustomDisplayStyle [bgTexture] [borderTexture] [includeIcon]

• Sets the display style to custom, then sets the background and border textures, as well as whether or not to include the exclamation mark icon
• bgTexture and borderTexture accept block names (e.g., oak_planks, stone) - autocomplete is available for valid block names
• includeIcon is a boolean (true or false) that determines if the exclamation mark icon is displayed
• Note: Icons do not work in Fabric 1.20.1 (see Version Compatibility section above)
• Settings are automatically saved to the config file

/gentlereminders set TicksBetweenMessages [ticks]

• Sets the number of ticks between messages

/gentlereminders set Message [id] [title] [message] [enabled] [titleColor] [messageColor]

• Overwrites the title, message, enabled status, and colors of a message by ID
• titleColor and messageColor accept color names - autocomplete is available for valid colors (see Config Guide for list)

/gentlereminders add Message [title] [message] [enabled] [titleColor] [messageColor]

• Adds a new message with the specified title, message, enabled status, and colors
• titleColor and messageColor accept color names - autocomplete is available for valid colors (see Config Guide for list)

/gentlereminders remove Message [id]

• Removes a message by ID

/gentlereminders enable GentleReminders

• Enables the mod

/gentlereminders enable Message [id]

• Enables a message by ID

/gentlereminders disable GentleReminders

• Disables the mod

/gentlereminders disable Message [id]

• Disables a message by ID