[INFO] rTriggers v2.4 - Messages/commands on login, death, commands and timers [1240]

rTriggers

MotD + Tips + Obituaries + Customization

Trigger messages on login, disconnect, timers, commands, death and more. Personalize those messages with tag replacements.

[ BUKKITDEV ]

[ SOURCE ]

Thanks to: Nossr50 for linebreak code, Fluff for the 'fictional Player' code, and ioScream for line continuation code!

1.0 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.)

2.0 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:

Code:

triggerers=recipients:options:message

The triggerers tell rTriggers who can set this message off, while the recipients are the ones who 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.

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 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!
• <<player|&rTriggers>>: Makes the recipient a fake player called &rTriggers. Use with <<command-recipient>> and give &rtTriggers permissions, and you can give players access to specific versions of commands!
• <<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 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.
• 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.

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.

3.0 List format:

These go in the same file as the messages.

Code:

<<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.


4.0 Example:

Code:

#################
# 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:$
@[URL='http://forums.bukkit.org/members/nothing.2505/']NothinG[/URL] 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?

5.0 Versions:
2.1.1 (2011/05/19)

• OH NO, A REMOVAL: ondeath|entity and ondeath|creaturename are gone; these are redundant to MonsterTriggers hooks, and MonsterTriggers does it better.
• New replacement tag: ondeath|playerkill gets a <<weapon>>, which tells you what the murder weapon was.
• New option: ondeath|natural and ondeath|natural|cause for when the death wasn't caused by a mob or a player (fire, drowning, falling, etc).
• Lightning is now an option for death causes/ will now fill in correctly
• (from Fluff of CommandSigns) Fake player code strengthened, no longer sends output of fake player to the player we've spoofed.
• New trigger: <<t|minutes>>. The message will trigger at that point in the hour. <<t|30>> will happen at 1:30, 2:30, and so on.
• New replacement tags: <<time>>, <<hour>>, and <<minute>>. These do what you probably think they do.
• <<param#>> tags now modify recipients and options. Go crazy, like <<param1>> for a group, or <<player|param1>> for a specific player, or delay|<<param2>> to have a variable delay on your command!
• oncommand option now has an optional setting for number of parameters. Example: oncommand|/say|override|4 or oncommand|/say|4 will only activate if the player uses exactly 4 parameters.
• Lots and lots of code refactoring
• <<triggerer-displayname>> and <<recipient-displayname>> tags for display name usage.

2.0_2 (2011/05/15)

• Support for Register 1.5
• Better regexes for split functions means better performance, and whitespace all you want. (You can put spaces around your =, commas and colons now.
• New recipient: <<player|&rTriggers>>. You can use this with <<command-recipients>> to have the fake player named "&rTriggers" use the command. Give &rTriggers permissions, and then you can alias commands for the player so they could do things they normally couldn't!
• New options:
  • delay|seconds - Lets you have the message happen however many seconds after the actual trigger happens.
  • limit|seconds - Won't let this message trigger again until after this many seconds have passed
  • limit|seconds|pertriggerer - Won't let this message trigger for this triggerer again until a certain amount of time has passed. Other triggerers can still set it off, however.
  • onrespawn - Pretty self explanatory.

1.9 (2011/05/13)

• Support for iConomy has been replaced by support for Register!
• New replacement tag: <<params>> <<param#+>> and <<param#->> allow for cooler use of oncommand!
• New Recipients: not|<<triggerer>>, not|groupname, not|<<player|playername>> allow you to remove would-be recipients
• New Triggerer: <<hasperm|permission>> lets you have people with a certain permission trigger a message!
• Manly refactoring: replaces many uses of ArrayList with nicer use of HashSets; less overhead on unused options!

v1.8 (2011/05/11)

• <<near-triggerer|radius>> recipient added!
• A whole ton of optimizations and refactorings.
• Hey, why don't you check out MonsterTriggers?

v1.7.1 (2011/05/09)

• Bugfixes, code refactoring
• Timers redone! No more weird options, just <<timer|interval>>
• Added <<command-console>>

v1.7 (2011/05/05)

• Support for iConomy updated to iConomy 5.0
• CraftIRC support, with new recipient psuedo-group: <<craftirc|irctaghere>>
• Added new tags: <<say-triggerer>> and <<say-recipient>>. Now you can make everyone say 'lol' at the guy who just drowned, or make someone who just died call himself an idiot!
• Made pseudo-groups like <<triggerer>> case-insensitive

v1.6 (2011/04/27)

• \@ works properly now.
• You can now use & instead of § or <<color>>
• Continue a message on the next line using $ at the very end of the line.
• <<command-triggerer>> and <<command-recipient>> can execute multiple commands if they are seperated by @.
• Playerlist no longer has a trailing comma!

v1.5.2 (2011/04/25)

• New option: onload|pluginname. Triggers after the chosen plugin gets loaded.
• New option: onlogin|override. Suppresses the default login option.
• New option: ondisconnect|override. Same as previous, but for disconnects.
• Fix for IndexOutOfBounds error on smaller group names.
• Some code refactoring/performance upgrades.

v1.4 (2011/04/16)

• Fix for NullPointerException on seemingly random deaths.
• Fix small memory leak.
• Smaller memory footprint in general (better use of HashTables)
• General restructuring.

v1.3_1 (2011/04/09)

• Lists are actually properly done now!

v1.2 (2011/03/29) - Update to match Bukkit 600. Added ondeath|entity, ondeath|playerkill, ondeath|creaturename, <<killer>>, and Lists!
v1.1 - Refactoring (now only registers events that are used!). Better code reuse, fixes bug where @ and <<color>> were not being replaced in timers.
v1.0 - Finally, Permissions (and indirectly, GroupUsers) support! Added parameter support to oncommand and onrtriggers!
v0.6_7 - New event: onkick. New tags: <<color>> and <<kick-reason>>. Some code cleanup/improvement, catching up with iConomy API changes. Fixed doubling of <<oncommand|>> triggers.
v0.5 - New recipients: <<command-triggerer>> and <<command-recipient>>
v0.4.5 - Updated to use new onEntityDeath hook. Should fix at least a few of the things about ondeath.
v0.4 - New recipient: Twitter. ServerEvents required for this.
v0.3_2 - ondeath trigger! Kind of. Only works with certain means of death. A few rebuilds to match changes to Bukkit APIs.
v0.2 - Reimplemented IP address. This time, it also does countries!
v0.1 - Initial porting from rMotD (HMod)!