Config and Tutorial
Config Tutorial
Ok, we'll start with the first thing on the config... MessageFormat. Now, this just means what format all your messages are going to be in! You have a couple variables to play around with; +pre, +suf, +gro, +pname, +dname and +msg. Now, whenever someone speaks, it'll send the message in this format, and just in all the respective variables. Lets say this is a segment of the config:
Groups: Admin: prefix: '&4[Admin] ' suffix: '&c[<--IsCool]'
So, with a MessageFormat like
'+pre+pname+suf&f: +msg'
, (And given I'm in admin group) It would place '&4[Admin]' in the prefix variable, my name in player variable, '&c[<-IsCool]' in the suffix variable, and whatever message I typed into the message variable. So it would come out like this:
Difference Between +pname and +dpname:
pname is the PlayerName, straight up. No changes, it just the name of the player. dname is DisplayName. It allows for other plugins (Such as essential's /nickname command) To change a players name, or what is also called, their DisplayName. So I could use "/nick Hotshot2162 AwesomeDude" which sets my nickname to AwesomeDude, now if I have the dname variable set, it would use AwesomeDude, but if I have pname set, it would use Hotshot2162.
Extra.yml
The extra yaml file provides tons of extra little features that simplechat can do. Of course, not everyone wants these features, and that's why there is an option to turn each one off.
# Each of these sections provides a different use/function. # I highly recommend reading through the commented section # before you start assigning values to things. # When I made this plugin, I understood that certain server # owners didnt need some of these features, so I added a # "use" variable to each section. By default, all are set to # true. But, if you dont not require a certain section, feel # free to set it to false. # All the explanations below are assuming that the respective # section if set to true. # +------------------------------------------------------+ # # | Chat Censor | # # | | # # | | # # | Here in the Chat Censor section, you can add words | # # | to the CurseWords list, and every time a person | # # | talks, it will search his/her chat message for any | # # | of these words. If one is found, it will replace the | # # | word with stars. Ex: fuck -> **** | # # | | # # | Available Variables: None. | # # +------------------------------------------------------+ # UseSimpleChatCensor: true CurseWords: - motherfucker - fuck - shit - bullshit - cock - dick - pussy - bitch - nigger - cunt - asshole - ass - bastard - beaner - blowjob - boner - choad - chode - cum - dumass - dyke - douche - faggot - fag - gay - handjob - hardon - hoe - humping - jackass - lameass - negro - nigga - nigger - nutsack - queer - queef - slut - skank - tard - testicle - vagina - whore # +------------------------------------------------------+ # # | Caps Preventer | # # | | # # | | # # | Here in the Caps Preventer section, you can set a | # # | limit on how many capital letters can be in a msg. | # # | If a player exceeds this limit, then they will be | # # | subject to the punishments you choose below. | # # | | # # | Punishments: | # # | kick -> if the kick punishment is set to true, it | # # | will kick the player when he uses too many| # # | capital letters. His message will not be | # # | displayed. | # # | msgToPlayer -> if this is set to true, it will | # # | send a message to the player when he uses | # # | too many caps. The message sent to the | # # | player can be configured "MsgToPlayer" | # # | replaceMsg -> if this is set to true, the player's| # # | original message will be replaced with | # # | a msg out of the ReplaceWith list. You | # # | may add your own and watch players get | # # | embarrassed when they use too many caps. | # # | | # # | Let it be noted that if a player uses too many caps, | # # | no matter which punishment is chosen, his original | # # | message will not be displayed. | # # | | # # | Available Variables: Color Codes (&a, &b, &1...) | # # +------------------------------------------------------+ # UseSimpleChatCapsPreventer: true MaxNumberOfCapitalLetters: 3 Punishment: kick: false msgToPlayer: true replaceMsg: true MsgToPlayer: '&4Please dont use caps, dude' ReplaceWith: - 'Look at my new dress!!' - 'Has anyone seen my dolly?' - 'This new makeup is amazing!' - 'I have to go! My ballet class is in 15 minutes!' - 'BRB, going to go try on my new dress!' - 'New Victorias Secret bra came in today! Im so excited!!' - 'My new favorite color has GOT to be pink!' # +------------------------------------------------------+ # # | Leave/Kick/Join Messages | # # | | # # | Here in the Other Messages section, you can set 3 | # # | different types of messages that are used on your | # # | server every day. | # # | | # # | join -> whatever this message is set to is what will | # # | be displayed whenever a player joins the | # # | server. | # # | leave -> whatever this message is set to is what | # # | will be displayed whenever a player leaves | # # | the server | # # | kick -> whatever this message is set to is what will | # # | be displayed whenever a player is kicked | # # | from the server. | # # | | # # | Available Variables: +pname: Player Name | # # | +dname: Display Name | # # | +pre: Player's Prefix | # # | +suf: Player's Prefix | # # | +gro: Group Name | # # | Only for kick --> +reason: Reason for kick/ban | # # | Color Codes (&a, &b, &1...) | # # +------------------------------------------------------+ # UseSimpleChatOtherMessages: true OtherMessages: join: '&a+pname &ehas joined the game.' leave: '&a+pname &ehas left the game.' kick: '&c+pname has been kicked from the game +reason.' # +------------------------------------------------------+ # # | Die Messages | # # | | # # | Here in the Die Messages section, you can set all | # # | the different die messages | # # | | # # | Available Variables: +pname: Player Name | # # | +dname: Display Name | # # | +pre: Player's Prefix | # # | +suf: Player's Prefix | # # | +gro: Group Name | # # | +other: The other entity | # # | Color Codes (&a, &b, &1...) | # # +------------------------------------------------------+ # UseSimpleChatDieMessages: true DieMessages: deathInFire: '+pname went up in flames.' deathOnFire: '+pname burned to death.' deathLava: '+pname tried to swim in lava.' deathInWall: '+pname suffocated in a wall.' deathDrowned: '+pname drowned.' deathStarve: '+pname starved to death.' deathCactus: '+pname was pricked to death.' deathFall: '+pname hit the ground too hard.' deathOutOfWorld: '+pname fell out of the world.' deathGeneric: '+pname died.' deathExplosion: '+pname blew up.' deathMagic: '+pname was killed by magic.' deathSlainBy: '+pname was slain by +other' deathArrow: '+pname was shot by +other.' deathFireball: '+pname was fireballed by +other.' deathThrown: '+pname was pummeled by +other.' # +------------------------------------------------------+ # # | Join Message (To Player Only) | # # | | # # | This join message is different then the one above. | # # | This one is sent to the player that just joined, no | # # | one else. This is usually used to give players info | # # | about the server they just joined. But it can also | # # | be used to display online players. I made a variable | # # | called <onlineplayers>. More info about this variable| # # | is below. | # # | | # # | Available Variables: +pname: Player Name | # # | +dname: Display Name | # # | +pre: Player's Prefix | # # | +suf: Player's Prefix | # # | +gro: Group Name | # # | <onlineplayers>: info below | # # | Color Codes (&a, &b, &1...) | # # +------------------------------------------------------+ # UseSimpleChatJoinMsg: true # The <onlineplayers> variable on this one can be a little tricky... # The syntax is: <onlineplayers:playernamecolor,commacolor,group> # The greater/less than signs are required at the beginning and # end of the variable. # It can be used in any of the following ways: # <onlineplayers:&4,&c,Admin> - this will make names dark red (&4), commas light red (&c), and only display the admin group. # <onlineplayers:&1,&7> - this will make names dark blue (&1) and commas gray (&7). It will display everyone because no group was specified. # <onlineplayers> - this is display all players, and it will all be white, because no colors were specified. # <onlineplayers:&e,&8,default> - this is make names yellow (&e), commas dark gray (&8), and only players from the default group. JoinMsgToPlayer: - '&5=====================================================' - '&a Welcome to the server, +pre +pname!' - '&a Please make sure youve read all the rules and such.' - '&4 Online Admins: <onlineplayers:&c,&4,admin> ' - '&a Online Members: <onlineplayers:&c,&4,member> ' - '&a Online Defaults: <onlineplayers:&c,&4,default> ' - '&5=====================================================' # +------------------------------------------------------+ # # | Format /me command | # # | | # # | Available Variables: +pname: Player Name | # # | +dname: Display Name | # # | +pre: Player's Prefix | # # | +suf: Player's Prefix | # # | +msg: The Message | # # | +gro: Group Name | # # | Color Codes (&a, &b, &1...) | # # +------------------------------------------------------+ # # So, this is as simple as it gets. The /me command. Just # Put in what you want for it to look like in chat when someone # Uses the /me command. UseSimpleChatMeFormatting: true MeFormat: '* &c+dname &7+msg' # +------------------------------------------------------+ # # | /msg and /reply formatting | # # | | # # | Available Variables: +pname | +otherpname | # # | +dname | +otherdname | # # | +pre | +otherpre | # # | +suf | +othersuf | # # | +gro | +othergro | # # | | # # | +msg | # # | Color Codes | # # | | # # | This formatting will also apply to: | # # | /message /msg /m /reply /r /tell /pm /whisper | # # +------------------------------------------------------+ # UseSimpleChatMsgAndReplyFormatting: true #This is what you would see if you were sending a message. SendingMessage: '&8&l[&r&7+pname &e-> &7+otherpname&8&l] &r&b&o+msg' #This is what you would see if you were receiving a message from another player. ReceivingMessage: '&8&l[&r&7+otherpname &e-> &7+pname&8&l] &r&b&o+msg'
Comments