Skip to content
Zach Sugano edited this page May 17, 2018 · 5 revisions
  1. Once you have followed the getting started instructions, there will be a folder in your plugins folder called "ZavMessage". Locate and open up that folder.
  2. Open config.yml in your preferred text editor.
  3. Enter in your own messages in the configuration.

Configuration Explained

Option What It Does Default Value
enabled This sets whether the plugin is running or not. Change to false to disable the plugin. true
wordwrap Should this plugin wordwrap to the next line automatically? Wordwrap should generally be set to false if you're entering your own new lines manually. false
delay The amount of seconds in between the processing of each message in the list 60
permissionsenabled Should this plugin process permissions? Unless you only want specific players to receive specific messages you can just leave this as true. false
chatformat This is the message format which is usually used for a prefix. "%msg" will be automatically replaced with the message in the list. '[&6ZavMessage&f]: %msg'
messageinrandomorder Sets weather or not the messages will appear in a random order or in a regular order false
messages Set the messages that will be displayed in the chat List of permission nodes with their corresponding chat messages
messagesinconsole Set if you want messages to appear in console true
requireplayersonline Set if you want messages to send only if a player is online true
dontrepeatrandommessages Set to true if you don't want random messages to be repeated true
suppressconsoleads Sets whether or not you will see ads for my donation links in the console of your server on startup false

Message Configuration Explanation

One of the awesome features of this plugin is that it is fully permissions compatible. Every message (Commands NOT Supported) can be assigned a permission node which can allow you to only display messages to certain users, groups, or worlds. Please note that all of these features are going to be dependent on your permissions setup.

Any messages under the default list will not have permissions checked and will be displayed to all users on the server that do not have messages set to ignore. You are able to define any arbitrary permissions node which can then be assigned like this:

messages:
    default:
    - 'This will be displayed to everyone.'
    zavmessage.group.admins:
    - 'Just give admins the above permission node and only they will see this message.'
    zavmessage.world.nether:
    - 'If your permissions supports multi-world. You can assign this permission to just people in the nether!'
    zavmessage.user.bob:
    - 'If you really want to, you can even send messages to just one specific person like this.'

Again, you will need to actually edit your permissions file for this to work. Those permissions nodes are just ones that I made up and you too can make up your own. They won't magically detect which group or world that a player is in. You will need to edit your permissions configuration to do that.

Clone this wiki locally