Tested Minecraft Versions:
Compatible with Spigot 1.7.10 - 1.12
WeChat is a custom chat replacement where users can quickly create public, or password protected private rooms with simple commands. Setup default rooms to start when your server loads to "reserve" them.
Note: If you are migrating from WeChat Alpha, please backup and generate a new configuration.
Join the WeChat Test server and test it out for yourself as a user. No room creation costs.
Test Server: 173.208.175.74
FEATURES
CREDITS
PERMISSIONS
COMMANDS
I haven't written a help menu yet, as it's on the least of my concerns, but I will go over basic available commands here.
Bold is required.
Example Commands
Code (Text):
# Help Menu
/wechat help
/wechat help 2
/wchelp
/wchelp 2
# Create a room
/wechat create TheLounge
/wc create TheLounge
/wc create TheClub ClubPass1
# Join a room
/wechat join TheLounge
/wc join TheLounge
/wcjoin TheLounge
/wc join TheClub ClubPass1
/wcjoin TheClub ClubPass1
# Invite a player
/wechat invite WASasquatch
/wc invite WASasquatch
/wcinvite WASasquatch
# Accept an invite
/wechat accept
/wc accept
/wcaccept
# Deny an invite
/wechat deny
/wc deny
/wcdeny
# Set / Change Password
/wechat passwd ClubPass1
/wc passwd ClubPass1
/wechat passwd ClubPass2 ClubPass1
/wc passwd ClubPass2 ClubPass1
# Leave a room
/wechat leave
/wc leave
/wcleave
# Remove a room
/wechat remove TheLounge
/wc remove TheLounge
/wc remove TheClub ClubPass1
# Send global message from room
/wechat global Hello World!
/wc global Hello World!
/wcglobal Hello World!
!Hello World
# Send a direct message to a room
/wechat msg TheLounge Hello World!
/wc msg TheLounge Hello World!
/wcmsg TheLounge Hello World!
# Kick a player from the room
/wechat kick WASasquatch
/wc kick WASasquatch
# Ban a player from the room
/wechat ban WASasquatch
/wc ban WASasquatch
# Unban a player from the room
/wechat unban WASasquatch
/wc unban WASasquatch
# Add a player as a mod to the room
/wechat mod add WASasquatch
/wc mod add WASasquatch
# Remove a mod from the room
/wechat mod remove WASasquatch
/wc mod remove WASasquatch
# Add a permenant owner to the room
/wechat addowner WASasquatch
/wc addowner WASasquatch
# Toggle accepting global messages
/wechat toggle
/wc toggle
/wctoggle
# Display public rooms or global
/wechat list
/wc list
/wclist
# Display users in room or global
/wechat users
/wc users
/wcusers
/wechat users TheLounge
/wc users TheLounge
/wcusers TheLounge
/wchat users ALL
/wc users ALL
/wcusers ALL
# Set the chat format
/wechat format &b
/wc format &b
# Set a new welcome message
/wechat welcomemsg &6Welcome to the channel:&r {ROOM}
/wc welcomemsg &6Welcome to the channel:&r {ROOM}
# Buzz a player
/wechat buzz WASasquatch
/wc buzz WASasquatch
/wcbuzz WASasquatch
EXAMPLE CONFIGURATION
English Example Configuration for v0.3.0
HELP EXAMPLE
- 1.7
- 1.8
- 1.9
- 1.10
- 1.11
- 1.12
Compatible with Spigot 1.7.10 - 1.12
WeChat is a custom chat replacement where users can quickly create public, or password protected private rooms with simple commands. Setup default rooms to start when your server loads to "reserve" them.
Note: If you are migrating from WeChat Alpha, please backup and generate a new configuration.
Join the WeChat Test server and test it out for yourself as a user. No room creation costs.
Test Server: 173.208.175.74
- Create Public or private Password Protected rooms.
- No Database! - Chat room data is so small there is no need for a database.
- Persistent Rooms - Users and rooms will be cached with your server restarting/stopping and restored on start.
- No Clutter! When you are in a room, there is no chit-chat from others outside your room to bother you.
- Chat Sounds! Optionally disable/enable notifications sounds for new global or room messages. Pitch and volume configurable.
- Default Rooms defined in config load with the server to be reserved.
- Set a default room for players to join when first signing on to the server
- Set a default room for returning players to join (if they aren't in a room)
- Set a default room for players to join when first signing on to the server
- Set Costs for room creation based on permission nodes. Following costs available:
- Vault Economy Cost
- Material Cost
- Experience Cost
- Vault Economy Cost
- Invite friends to your rooms!
- Create Welcome Messages for your rooms
- Set the Chat Format for your rooms
- Send Global chat messages from rooms
- Toggle Receiving Global chat messages in rooms on or off.
- Note: users still get broadcast announcements or other commands that specifically target them. Global chat messages are automatically enabled for OPs / Admins on join.
- Send Chat Actions in rooms much like the /me command with a defined character. Default *
- Chat Censoring - Censor the chat of profanity with unique replacements. Additionally censor URLs
- Chat Formatting - Allow chat formatting, or limit formatting based on permission nodes
- Chat Cooldown - Prevent users from sending messages too fast.
- Owners - Add a user as a permanent owner of a room.
- Moderators - promote moderators for your rooms to kick/ban pesky users!
- Buzz players to get their attention
- Kick pesky users
- Ban the even peskier users, or Unban users.
- Remember players room when exiting, and log back in to that room when logging in to the server. So long as the password hasn't changed.
- List Public Rooms (or as OP / Admin, list all public and private rooms)
- List Users in a Room (or as OP / Admin list all global users in rooms)
- Limit Max Rooms a player can create at once. Optionally bypass global limit on a per-user basis with a permission node.
- A customizable Help Menu. Translate it to your native language to explain commands to your community.
- All phrases can be customized to your native language!
- EssentialsChat - Doesn't critically break anything but interferes with URL Censorship.
- EssentialsXChat - Doesn't critically break anything but interferes with URL Censorship.
- Swiftlicious - Offering great suggestions regarding chat filtering and and the addition of URL formatting and limiting formatted messages to those with correct permission node, and much more!
- SGT_Shan - Very generously offering a Deutsch translation.
- MrMaurice211 - Help with mathing for new timers, and inadvertently pointing out a ridiculous mistake
- Mokur0h - Supporting WeChat with new ideas, such as global messages and shorthand global messages! Pointing out bugs, which is a big help.
- RichardB122 - Base code for ExperienceManager (gist)
- My Fiancee Ändréa - For love and support, of course!
- wechat.create (A user must have this to create a room, even with cost nodes)
- Allows creation of a chat room
- wechat.create.expcost
- Allows creation of a chat room at the cost of Experience (defined in config)
- wechat.create.itemcost
- Allows creation of a chat room at the cost of Material (defined in config)
- wechat.create.vaultcost
- Allows creation of a chat room at the cost of Vault Economy Cash (defined in config)
- wechat.invite
- Allows sending invites to players
- wechat.buzz
- Allows sending a buzz to a player
- wechat.format (A user must have this to use formats, even with a invalid format node)
- Allows player to use formatting in their messages (if not Op/Admin)
- wechat.format.<invalid_formats>
- Strips users message of the listed formats.
- Ex: wechat.format.lmnok (Remove all non-color formats)
- Ex: wechat.format.0-9abcdef (Remove all colors)
- Ex: wechat.format.0134589 (Remove dark colors)
- Strips users message of the listed formats.
- wechat.bypass.wordcensor
- Allows player to post profanity in their messages (if not Op/Admin)
- wechat.bypass.urlcensor
- Allows player to post URLs in their messages (if not Op/Admin)
- wechat.maxrooms.<MAX_ROOMS>
- Allows player to bypass default max rooms with a defined value between 1 - 30
- Ex: wechat.maxrooms.10
- Allows player to bypass default max rooms with a defined value between 1 - 30
- wechat.list
- Allows viewing of public rooms (or private if Op/Admin)
- wechat.users
- Allows viewing of users (or all global users if Op/Admin)
- wechat.global
- Allows sending global chat messages (if not OP/Admin)
- wechat.direct
- Allows sending a direct messages to a room (if not OP/Admin)
- wechat.help
- Allows viewing WeChat Help Menu.
- wechat.admin
- Allows administration of WeChat plugin
I haven't written a help menu yet, as it's on the least of my concerns, but I will go over basic available commands here.
Bold is required.
- /wechat (or just /wc)
- help
- PAGE_NUMBER
- create - Create a room
- ROOM_NAME PASSWORD
- join - Join a room
- ROOM_NAME PASSWORD
- remove - Remove a room if OP/Admin/Owner
- ROOM_NAME PASSWORD
- passwd
- NEW_PASS OLD_PASS
- kick - Ban a player from the room if OP / Admin / Owner / Room Mod
- USERNAME
- ban - Ban a player from the room if OP / Admin / Owner / Room Mod
- USERNAME
- unban - Unban a player from the room if OP / Admin /Owner Room mod
- format - Set the format of the rooms chat
- FORMAT_CODES (Valid color/format codes start with &)
- welcomemsg - Set the welcome message of a room
- WELCOME_MESSAGE (Valid color/format codes start with &)
- list - Display list of public rooms or public and private if OP / Admin
- users - Display users in room or global users if OP / Admin
- ROOM | ALL
- invite - Invite a player
- USERNAME
- accept - Accept an invite
- deny - Deny an invite
- mod - Manage moderators
- add - Add a moderator to the room
- USERNAME
- remove - Remove a moderator from the room
- USERNAME
- add - Add a moderator to the room
- addowner - Add a permenant owner to the room.
- USERNAME
- global - Send a global chat message if player has wechat.global or is OP / Admin
- MESSAGE
- msg
- ROOM
- MESSAGE
- ROOM
- toggle - Toggle Global Message on/off
- buzz - Buzz a player to get their attention
- USERNAME
- help
- /wchelp
- PAGE_NUMBER
- /wcjoin
- ROOM_NAME PASSWORD
- /wcleave
- /wclist
- /wcusers
- ROOM | ALL
- /wcinvite
- USERNAME
- /wcaccept
- /wcdeny
- /wcbuzz
- USERNAME
- /wcmsg
- ROOM
- MESSAGE
- ROOM
- /wcversion
Example Commands
Code (Text):
# Help Menu
/wechat help
/wechat help 2
/wchelp
/wchelp 2
# Create a room
/wechat create TheLounge
/wc create TheLounge
/wc create TheClub ClubPass1
# Join a room
/wechat join TheLounge
/wc join TheLounge
/wcjoin TheLounge
/wc join TheClub ClubPass1
/wcjoin TheClub ClubPass1
# Invite a player
/wechat invite WASasquatch
/wc invite WASasquatch
/wcinvite WASasquatch
# Accept an invite
/wechat accept
/wc accept
/wcaccept
# Deny an invite
/wechat deny
/wc deny
/wcdeny
# Set / Change Password
/wechat passwd ClubPass1
/wc passwd ClubPass1
/wechat passwd ClubPass2 ClubPass1
/wc passwd ClubPass2 ClubPass1
# Leave a room
/wechat leave
/wc leave
/wcleave
# Remove a room
/wechat remove TheLounge
/wc remove TheLounge
/wc remove TheClub ClubPass1
# Send global message from room
/wechat global Hello World!
/wc global Hello World!
/wcglobal Hello World!
!Hello World
# Send a direct message to a room
/wechat msg TheLounge Hello World!
/wc msg TheLounge Hello World!
/wcmsg TheLounge Hello World!
# Kick a player from the room
/wechat kick WASasquatch
/wc kick WASasquatch
# Ban a player from the room
/wechat ban WASasquatch
/wc ban WASasquatch
# Unban a player from the room
/wechat unban WASasquatch
/wc unban WASasquatch
# Add a player as a mod to the room
/wechat mod add WASasquatch
/wc mod add WASasquatch
# Remove a mod from the room
/wechat mod remove WASasquatch
/wc mod remove WASasquatch
# Add a permenant owner to the room
/wechat addowner WASasquatch
/wc addowner WASasquatch
# Toggle accepting global messages
/wechat toggle
/wc toggle
/wctoggle
# Display public rooms or global
/wechat list
/wc list
/wclist
# Display users in room or global
/wechat users
/wc users
/wcusers
/wechat users TheLounge
/wc users TheLounge
/wcusers TheLounge
/wchat users ALL
/wc users ALL
/wcusers ALL
# Set the chat format
/wechat format &b
/wc format &b
# Set a new welcome message
/wechat welcomemsg &6Welcome to the channel:&r {ROOM}
/wc welcomemsg &6Welcome to the channel:&r {ROOM}
# Buzz a player
/wechat buzz WASasquatch
/wc buzz WASasquatch
/wcbuzz WASasquatch
English Example Configuration for v0.3.0