rTriggers
MotD, Tips, Obituaries, Macros, Customization Trigger messages on login, disconnect, timers, commands, death and more.
Personalize messages with tag replacements.
Features
- Trigger messages or commands on login, disconnect, timers, or even player death and command uses.
- Decide exactly who can set off a message, and who gets it. Name players individually or by group (via Permissions).
- Line breaks on words, colour continuations (thanks to modified vMinecraft code!)
- Personalized, fill-in-the-blanks style messages (insert the triggerer or recipient's name/IP/whatever here.)
Messages format
Example properties file is in the section 4.0. rTriggers will make a properties file at plugins/rTriggers/rTriggers.properties, where plugins is in your server's folder.
The properties file consists of a list of your messages. Each message is formatted like this:
triggerers=recipients:options:message
The triggerers tell rTriggers which groups or psuedogroups can set this message off. Recipients are the ones who actually see the message when a triggerer sets it off. Options tell when and in what manner a triggerer can set off a message (like when logging in, dying, or using a certain command). The message is the actual thing that gets sent.
One can specify multiple things in the triggerers, recipients, and options fields by using commas (no spaces). What each field does is described in a section below.
Legend
If it has <<>> around it, you need to include those! bold: The name of the option/group/whatever italics: An optional part of the tag. You can leave this out (leave out any | in front of it, too). underlined: You replace this with something (like a number, or a group name). Necessary, unless it's italics.
Triggerers and Recipients
Triggerers tell rTriggers who can set this message off. Recipients tell who sees this message whenever a triggerer sets it off. Leaving the recipients field blank will default the recipient to just the triggerer. groupname: Members in this group will trigger the message (or receive it, if they're in the recipients field).
<<everyone>>
: Everyone!<<hasperm|permissionnode>>
: People with the stated permission trigger/receive this message.<<player|playername>>
: Replace playername with the name of the player you want to be a triggerer (or a recipient).<<command-triggerer>>
and <<command-recipient>: Makes the player use the message as if it were a command.<<command-console>>
: Makes the server console use the message as if it were a command.<<say-triggerer>>
and<<say-triggerer>>
: Makes the player say the message.<<timer|interval>>
: (Triggerer only) Will repeat this message (replace 'interval' with how often you want to repeat the message in seconds). Use with lists to make tips!<<t|minutes>>
: This message will repeat every hour at this minute (<<t|30>>
happens at 1:30, 2:30, etc.)<<server>>
: (Recipient only)Message is sent to the server.<<triggerer>>
: (Recipient only) The person who triggered the message.<<twitter>>
: (Recipient only) Sends the message to Twitter (ServerEvents required!!!)<<near-triggerer|dist>>
: (Recipient only) Everyone inside a dist x dist square around the triggerer gets the message. Replace 'distance' with the active area of this.- not|groupname and not|
<<player|playername>>
and not|<<triggerer>>
and not|<<hasperm|permission>>
: (Recipient only, except for hasperm) Works like the versions without 'not|' in front of them, except it makes sure that the message WON'T get sent to that person/those persons. <<craftirc|tagname>>
: (Recipient only) Replace 'tagname' with the name of the tag you want CraftIRC to send the message to.
Options
Options tell rTriggers when the message should trigger, and how. Leaving this blank is the same as using the onlogin option.
- onlogin|override - Triggers when a triggerer logs in. Override will replace the default message with a blank line.
- ondisconnect|override - Triggers when a triggerer logs out. Override will replace the original disconnect message with a blank line.
- oncommand|commandname|override|number - Triggers when a triggerer uses the specified command. Override doesn't let the command move to other plugins (removes the 'unknown command!' prompts). The number specifies the number of required arguments.
- onconsole works like the oncommand event, except you can't override these. :( Not yet, anyway.
- onload|pluginname - Whenever the plugin called pluginname is loaded by CraftBukkit. Use with
<<customtrigger>>
as the triggerer. - onkick - Triggers when a triggerer gets booted from the server.
- ondeath|natural|deathcause - Triggers when a triggerer dies. If deathcause is specified, will only trigger on that manner of death. Possible death causes are: "contact", "entity_attack", "fall", "fire", "fire_tick", "lava", "drowning", "block_explosion", "entity_explosion", "suffocation", "custom", "lightning", and "something." If the natural option is used, then it will not trigger if the player died by playerkilling, or from a mob.
- ondeath|playerkill - Triggers when a triggerer is killed by a fellow player.
- delay|seconds - Makes the message wait a few seconds after being triggered before happening
- limit|seconds|pertrigger - Keeps a message from triggering faster than specified. If pertrigger is specified, then this limit is done on a per-player basis, rather than being for everyone.
Messages and Replacement Tags
This is what you want rTriggers to say or do. You can customize it with replacement tags, which rTriggers will find and replace with the appropriate information. Here's a list of replacement tags:
<<triggerer>>
- The name of person who triggered the message (by logging in, getting kicked, etc).<<recipient>>
- The name of the person who the message is being sent to (may be the same as triggerer in many cases).<<recipient-displayname>>
and<<triggerer-displayname>>
- The display name (as opposed to the raw name).<<player-list>>
- A list of all the players online.<<color>>
- Replaced with §. Follow up with a hexadecimal number to get a color! (0-9 or A-F)<<triggerer-balance>>
and<<recipient-balance>>
- The player's iConomy balance.<<death-cause>>
- (ondeath only!) The cause of death.<<killer>>
- (ondeath only!) The killer (player name, creature name, etc.)<<kick-reason>>
- (onkick only!) The reason given for kicking the player. oncommand only!<<param#>>
- Replace the # with parameter number, like<<param1>>
, etc. It's replaced by what the player puts into the command.<<param#+>>
and<<param#->>
- is replaced by all the parameters up to and including that number/starting with and following that number.<<params>>
- Is replaced by all the parameters put into the command<<list|listname|rand>>
- Will be replaced by an item in the list called "listname." If rand is specified, it will give a random one from the list. If not, it will go down the list sequentially. IP Address/Location related:<<triggerer-ip>>
and<<recipient-ip>>
- The player's IP Address.<<triggerer-locale>>
and<<recipient-locale>>
- The player's location.<<triggerer-country>>
and<<recipient-country>>
- The player's country.<<time>>
,<<hour>>
, and<<minute>>
: These do what you probably think they do.<<everyone>>
and<<hasperm|permission>>
the message will be repeated once for each player online/with that permission, with this tag replacement- You can use them multiple times in a message, and use different ones in a message.
- If you use the same tag multiple times, it will only trigger once for each player that it applies to. That is, making someone execute "/tell
<<everyone>>
Hello there,<<everyone>>
!" will only make them say hello to everyone by their name. It won't make them list off every player to every player. - If you use different ones, it'll go through every valid combination that satisfies those tags.
List Format
These go in the same file as the messages.
<<list|Bob>>=This text goes in the 'Bob' list. <<list|Bob>>=This is also in the 'Bob' list. <<list|haha>>=This is in a separate list called 'haha'
You replace "listname" with whatever name you want. You can use replacement tags here, if you like.
If you use either the replacement tag <<list|listname|rand>>
or <<list|listname>>
will be replaced by an item in the list called "listname." If 'rand' is specified, this item will be randomly selected from the list. If not, it will just pick the 'next' item on the list. Order is determined by the order you put it in the file.
Example
################# # MOTD Example: # Basic MotD for humans group humans=::§b Hey <<triggerer>>!@ Type /rules for a list of rules. # News that shows when players log in. # Also shows up when players type /news. # Use $ to continue on the next line, and @ to insert a linebreak. <<everyone>>=:onlogin,oncommand|/news|override:<<color>>b Here's our latest events:$ @Nothing at all, really! # Tells anyone in the 'humans' or 'gods' group who's online when they log in. humans,gods=::<<player-list>> #Displays rules when people use the /rules command <<everyone>>=<<triggerer>>:oncommand|/rules|override:1) Don't break things.$ @2) Have fun.$ @3) RESPECT MAH AUTHORATAH! # Announces the login and disconnect of anyone in the 'gods' group to the server gods=<<everyone>>:onlogin,ondisconnect:<<recipient>> pay heed, and hail <<triggerer>>, your god! #################### # Tips/Timer Example # This one does it sequentially <<timer|300>>=<<everyone>>::<<list|TipList>> # This version will pick a random tip <<timer|300>>=<<everyone>>::<<list|Burn|rand>> # Here are your tips <<list|TipList>>=This tip comes first. <<list|TipList>>=You see this tip 5 minutes (300 seconds) later. <<list|TipList>>=This one comes 5 minutes after the one above! # This timer makes the server use the backup command every 10 minutes! <<timer|600>>=<<command-console>>::backup ############## # Commands/Aliases example # Will announce whenever someone /tps to someone. <<everyone>>=<<everyone>>:oncommand|/tp:<<triggerer>> tp'd to <<param1>>! # Map multiple commands to one! # /suitup <target> # Gives the target player a full suit of iron armor and then teleports you to the target. gods=<<command-triggerer>>:oncommand|/suitup:give <<param1>> ironchestplate 1$ @give <<param1>> ironpants 1$ @give <<param1>> ironboots 1$ @give <<param1>> ironhelmet 1$ @tp <<param1>> ############## #Death Related stuff # Will announce the weakness of a god when he or she dies. god=<<everyone>>:ondeath:Even a god like <<triggerer>> can die... # Will randomly select something in the list "Burn" whenever someone burns to death. <<everyone>>=<<everyone>>:ondeath|fire:<<list|Burn|rand>> <<list|Burn>>=Let it burn! Just like <<triggerer>>. <<list|Burn>>=Would you like your <<triggerer>> medium or well done?
Am I doing something wrong here? I'm trying to make it so when you join the server it automatically makes the user run /change.
I am getting this error when trying to load the new version 2.7 (using latest Spigot build)
http://pastebin.com/GCmYif3p
@Ahellhound
Huh, that's something I've not seen before. What other plugins do you have that use your local database? Does the plugin function abnormally/not at all after that error?
@Reilaos
I'm receiving this strange error with Spigot #1049, and Craftbukkit #2825:
http://pastebin.com/HSMjt5ac
My other plugins work fine when connected to my local MySQL database.
-Thanks for the help
@Reilaos
I'll test the non-listed version out here soon. Thanks!
I just updated my server to MC 1.6.2 (spigot 1040) so far so good.
@Liger_XT5
Okay, but does the error happen if you use just a plain message, and not a list? Or, alternatively, does using a list in any other context break anything? I'm still not sure why there's a null pointer. :s
On the other note, I took a look at the not|
<<hasperm|asdfasdlk>>
stuff, and I think I see the error. I'm an idiot, and I'm not sure why this hasn't been noticed before. The fix is ready for the next version.I think I retooled some of the code to do param#+ thing, but I haven't actually, well, tested it. I'm lazy. >_<
@Reilaos
Even with |rand removed, I get the error.
Also, an addition, found another odd little bug. No one bothered to notify until today.
In a chat such as this, this one is for staff only to see:
If you try to type a sentence with a $ in it, it doesn't work. No errors or anything.
Also, the suggestion you made about hasperm| works, as long as each group inheriting after said group has the same perm with - before it to state it doesn't have the perm. Example: Moderator has rtriggers.staff.moderator, admins has the same, but with - before it and has the same but as admin. Owner has the same for the two, stating it removes admin and adds owner, but it's detected to have moderator still.
I've also noticed, and someone else asked me about it, doing not|
<<hasperm|xyz>>
does not work. So if I want to have<<everyone>>
but not staff, I have to list each group (or set a perm that is inherited it through a set of them).@Reilaos
All my custom death messages were random. I'll add one in that is not and see what comes up. I'll let you know later today. Though it's my day off, have a number of things piled up. *sigh*
Thanks for checking up on everything!
@Liger_XT5
Okay, now that I've taken a look at this; does this error only show up when it's using that random list/any list? The error is pointing at a line in the list-replacement function, which seems odd to me.
@austindkelly
The source code has actually been up at GitHub for as long as the project's existed. Check it out here:
https://github.com/reil
Under, obviously, rTriggers, but you'll also need code from rParser, which is also there. (rParser is code that I used in various projects for Bukkit, it did text-related things).
The code's pretty messy, to be quite honest; the plugin began as a Message of the Day plugin, with all the functionality added piece by piece as I needed it or as people requested.
I'll look into the features you guys are talking about. It shouldn't be too hard. Then again, trying to track down this death error thing shouldn't be taking as long as I have been so...
@Liger_XT5
I would love to see this as well. I could do a lot with a feature add like this.
Not sure if the developer has plans to update or not again. It took some prodding to get the last update IIRC. Not sure how committed to this project the developer is or if the developer is willing to share source code so it can be improved and maintained by someone else.
I know you are possibly doing a rewrite, but haven't heard much in a while. Room for a Feature Addition?
oncommand|commandname|override|number - Triggers when a triggerer uses the specified command. Override doesn't let the command move to other plugins (removes the 'unknown command!' prompts). The number specifies the number of required arguments.
Could you add in, like you did in <<param1+> for the |number?
If the command doesn't have the number variables, maybe a way we could customize an error to report back?
So far, what I've set, for commands such as /member, I've set it up that it's required to have one name. But if someone does /member, they just get the unknown command message. So I put an extra line command for |0, which caught that. Worked great.
If I put it in a group chat setup, such as /schat for staff only chat, if I put, let's say |5, it requires exactly 5 spaced words or such. No more, no less.
Needless to say, after I noticed that extra feature, it has stopped a lot of mistake commands. Thanks!
rTriggers keeps making exceptions, can anybody help me?
@FUNxLOL
You sort of can do that.. it wouldn't be them actually running the /me command but you can have it display it as a global message that looks exactly like however your /me is configured to look. Try this:
<<everyone>>
=<<everyone>>
:onlogin:<<triggerer>>
has joined the server! then add color coding and symbols to make it look exactly like a /me@FUNxLOL
They will need to have access to the /me command.
is it possible to do
<<everyone>>
=<<command-triggerer>>
:onlogin:me joined the server! as example, even if they don't even have permission for the /me command?Reilaos: Please update your "The Thu'um" plugin for when 1.6 comes out. Please!
@Liger_XT5
I thought not|
<<hasperm|permnode>>
means any player without the permission node? Shouldn't it just trigger the action when a player who doesn't have perm node rtriggers.gotmoney logs in and then give them money and then give them the perm node?@x_clucky
You need to put
<<everyone>>
,not|<<hasperm|etc.etc.etcOtherwise it doesn't do it to anyone because no one is stated to who it can work with.
Anyone have an idea why these two aren't working?