CoreEngineWIKI
ESC
NavigateEnter OpenESC Close

Reminder

Over time a server collects many modules and commands, and not every player knows them all. The reminder module therefore sends a short tip to the chat every 30 minutes: a command, a tool or a feature worth knowing. The tips follow the server's setup, important things come up more often, and the same tip never appears twice in a row.

How it works #

  • Every shipped tip belongs to a module and only appears while that module is enabled. Switch off jobs, for example, and the job tips disappear on their own.
  • Every tip has a weight: 3 for things every player should know (claiming land, saving a home, /guide), 2 for everyday features, 1 for niche ones like the team chat. The higher, the more often the tip comes up.
  • The tip shown last is never repeated as long as another one exists.
  • Tips only go to players who are online and hold the permission reminder.receive.
  • All texts live in messages.yml under reminder.tips and can be adjusted or translated there. The prefix is TIP » and is set under prefixes like every other prefix.

Permissions #

Permissions1
PermissionDefaultDescription
reminder.receivetrueReceives the tips. Revoke it to exempt a group (for example staff)

Configuration (modules/reminder.yml) #

YAML
# Enables or disables the reminder module.
enabled: true

reminder:
  # Minutes between two tips.
  interval-minutes: 30
  # The tips shipped with the plugin (texts in messages.yml under
  # reminder.tips). Every one belongs to a module and only appears while
  # that module is enabled.
  builtin-tips: true
  # Shipped tips you never want to see, by id (the keys under
  # reminder.tips), for example [claim-subdivide, baltop].
  disabled-tips: []
  # Your own tips. text is MiniMessage, weight says how often a tip comes
  # up compared to the others (shipped tips use 3, 2 and 1), module limits
  # the tip to the time a module is enabled (empty = always).
  custom: []

Your own tips #

Add your own tips under custom. Every entry needs a text, weight and module are optional:

YAML
reminder:
  custom:
    - text: "<gray>Questions? Our Discord helps: <yellow>discord.gg/example</yellow>"
      weight: 3
    - text: "<gray>Team plots are at the market, have a look with <yellow>/warp market</yellow>."
      weight: 1
      module: team

The first tip always qualifies and shows about as often as an important shipped tip, the second only while the team module is enabled, and rarely.

💡

Tip: An interval of 20 to 45 minutes works well. Shorter quickly feels like spam, longer means many players never see a tip during a session.

Shipped tips #

Id18
IdModuleWeight
guide, wikialways3, 2
cwebweb interface2
claim-shovel, claim-trustclaims3
claim-stick, claim-blocksclaims2
claim-trapped, claim-subdivideclaims1
sethomehomes3
homes-listhomes1
warps, tpa, spawn, back, rtpteleportation2
payeconomy2
baltopeconomy1
shopchest shops2
jobsjobs3
jobs-questsjobs1
team-createteams2
team-chat, team-hometeams1
msgprivate messages2
stations, upgradestations, enchantment upgrades2
nick, cosmetic, afk, sleep, trashnicknames, cosmetics, AFK, sleep, utility1