Gentle Reminders

Gentle Reminders is a mod that sends mindful messages to the player every so often based on a customizable config file.

Features

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
Config Guide below
Commands Guide below
Can choose a Display Style, currently the default Minecraft toast system or by a chat message
Can choose some custom toasts via Display Style, currently light or dark

Upcoming Features

Add a drastically large amount of messages
- Current # of simple messages: 34
- Current # of unique/special messages: 62
More custom toast display styles
Custom message icons (instead of an exclamation point)
Custom message noises?
Make some super cool GUI to edit how the custom toasts look
Implement more options into config, possibly split into multiple files
Create own UI popup with more customization as opposed to using Minecraft's built-in toast system

Message Examples

A Simple Message, using the "default" display style
Simple Message Default

A Unique Message, using the "chat" display style
Unique Message Chat

A Unique Message, using the "light" display style
Unique Message Light

A Unique Message, using the "dark" display style
Unique Message Dark

A Unique Message in-game, using the "default" display style

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]