The Basics - Roleplay (RP) Proximity Chat and more!

As seen on Saltpoint RP, Fair Travels, The Expansion, Echoes of the Ancients, Lunaria, and various other servers!

The Basics

Mod Systems:

• Roleplaying (RP) local proximity chat system, with configurable talking ranges, nicknames, automatic message formatting, and more!
• Server save notification (sends a message when save starts, which can help lower frustration about lag for large worlds)
• Player sleep notification (encourages players to go to sleep when at least 50% of players are in bed)
• Player Stats system (Keeps track of stats about players that can be viewed by anybody.  Currently tracks deaths, player kills, and NPC kills)
• TPA System (Allow players to teleport to each other by consuming a temporal gear)
• Repair system (Adds an admin command /setdurability to set the durability of an item held in your hand)

Join my discord for support! https://discord.gg/PYKTaJ5Ett

Roleplay Proximity Chat System

Adds a Proximity chat tab with local chat designed for roleplaying

Yell or whisper!

Speak in configurable languages, so that only others that speak it can understand you!

Use emotes and environment messages for additional flavor!

Use Bold and Italics to spice things up!

Commands:

Note: [value] denotes a required argument, while (value) denotes an optional one  Pipes (|) denote a range of allowable values. Aliases are listed after the first string, but with argument lists omitted.

• Nicknames
  • "/nick (nick)", "/setnick", "/nickname" - Get or set your nickname
  • "/clearnick" - Clear your nickname
  • "/nickcolor (color)" - Get or set your nickname color
  • "/clearnickcolor" - Clear your nickname color
  • "/adminsetnickname \[player\] (nickname)"
• Chat modes/Chat messages
  • "/yell (text)", "/y" - Set your chat mode to Yelling, or yell a single message
  • "/whisper (text)", "/w" - Set your chat mode to Whispering, or whisper a single message
  • "/say (text)", "/normal", "/s" - Set your chat mode back to normal, or say a single message
  • "/ooc (text)" - Send a message in local OOC
    • can also be performed by wrapping your message in `(message)` (by default, delimiters configurable) instead of using the command
  • "/gooc (text)" - Send a message in global OOC
    • can also be performed by wrapping your message in `((message))` (by default, delimiters configurable) instead of using the command
• Chat Messages
  • "/me \[text\]", "/m" - ("\*" prefix) - Send a proximity emote message
    • can also be performed by prefixing your message with `*message` (by default, delimiters configurable) instead of using the command
  • "/it \[text\]" - ("!" prefix) - Send a proximity environment message
    • can also be performed by prefixing your message with `!message` (by default, delimiters configurable) instead of using the command
• Configurable Options
  • "/emotemode \[on|off\]" - Turn Emote-only mode on or off
  • "/rptext \[on|off\]" - Turn the whole RP system on or off for your messages
• Languages
  • Player Commands
    • "/addlang \[langCode\]" - Add a known language
    • "/remlang \[langCode\]" - Remove a known language
    • "/listlang \[langCode\]" - List your known languages, and all available languages
  • Admin Commands
    • "/adminaddlang \[player\] \[langCode\]" - Add a language to another player
    • "/adminremlang \[player\] \[langCode\]" - Remove a language from another player
    • "/adminlistlang \[player\]" - List a player's known languages
• Player Stats
  • "/playerstats (player)" - Get your player stats, or another players
  • "/clearstats [player] (confirm)" - Clear all of the stats of a player
  • "/clearstat [player] [statName] (confirm)" - Clear a specific stat a player
• TPA (Teleport) System
  • "/tpa [player]" - Request to teleport to another player
  • "/tpahere [player]" - Request to teleport another player to you
  • "/tpaccept" - Accept a pending teleport request
  • "/tpdeny" - Deny a pending teleport request

  Note: TPA requires a temporal gear to use by default, and can be configured with cooldowns and permissions.

• Repair System
  • "/setdurability [value]" - (Admin only) Set the durability of the item you're holding

Configuration:

{
  // ----- Proximity Chat ----- //
  "ProximityChatModeDistances": {
    "Yell": 90,    // Maximum distance for yelling
    "Normal": 35,  // Normal talking distance
    "Whisper": 5,  // Whisper range
    "Sign": 15     // Sign language visibility range
  },
  "ProximityChatAllowPlayersToChangeNicknames": true,
  "ProximityChatAllowPlayersToChangeNicknameColors": true,  // Whether players can change their nickname colors
  "ChangeNicknameColorPermission": "chat",  // The privilege required to change nickname colors (if allowed)
  "EnableDistanceObfuscationSystem": true,
  "ProximityChatModeObfuscationRanges": {
    "Yell": 45,
    "Normal": 15,
    "Whisper": 2,
    "Sign": 15
  },
  "EnableDistanceFontSizeSystem": true,
  "ProximityChatDefaultFontSize": {
    "Yell": 30,
    "Normal": 16,
    "Whisper": 12,
    "Sign": 16
  },
  "ProximityChatClampFontSizes": [30, 16, 12, 6],
  "BoldNicknames": false,
  
  // Message formatting
  "ProximityChatModeVerbs": {
    "Yell": ["yells", "shouts", "exclaims"],
    "Normal": ["says", "states", "mentions"],
    "Whisper": ["whispers", "mumbles", "mutters"],
    "Sign": ["signs", "gestures", "motions"]
  },
  "ProximityChatModeBabbleVerb": "babbles",
  "ProximityChatModePunctuation": {
    "Yell": "!",
    "Normal": ".",
    "Whisper": ".",
    "Sign": "."
  },
  "ProximityChatModeQuotationStart": {
    "Yell": "\"",
    "Normal": "\"",
    "Whisper": "\"",
    "Sign": "'"
  },
  "ProximityChatModeQuotationEnd": {
    "Yell": "\"",
    "Normal": "\"",
    "Whisper": "\"",
    "Sign": "'"
  },

  // ----- Server Save Announcement ----- //
  "SendServerSaveAnnouncement": true,
  "SendServerSaveFinishedAnnouncement": false,
  "TEXT_ServerSaveAnnouncement": "Server save has started - expect lag for a few seconds.",
  "TEXT_ServerSaveFinished": "Server save has finished.",

  // ----- Player Stats ----- //
  "PlayerStatSystem": true,
  "PlayerStatToggles": {
    "Deaths": true,
    "NpcKills": true,
    "PlayerKills": true,
    "BlockBreaks": true,
    "DistanceTravelled": true
  },
  "PlayerStatClearPermission": "commandplayer",
  "PlayerStatDistanceTravelledTimer": 2000,

  // ----- TPA Requests ----- //
  "AllowPlayerTpa": true,
  "AllowTpaPrivilegeByDefault": false,
  "TpaRequireTemporalGear": true,
  "TpaUseCooldown": false,
  "TpaCooldownInGameHours": 0.5,

  // ----- Sleep Notifications ----- //
  "EnableSleepNotifications": true,
  "SleepNotificationThreshold": 0.5,
  "TEXT_SleepNotification": "You start to feel tired...",

  // ----- Language System ----- //
  "EnableLanguageSystem": true,
  "ChangeOwnLanguagePermission": "chat",
  "ChangeOtherLanguagePermission": "commandplayer",
  "MaxLanguagesPerPlayer": 3, // Maximum number of languages a player can know at once, -1 for unlimited
  "Languages": [
    {
      "Name": "Common",
      "Description": "The universal language",
      "Prefix": "c",
      "Syllables": ["al", "er", "at", "th", "it", "ha", "er", "es", "s", "le", "ed", "ve"],
      "Color": "#92C4E1",
      "Default": true,
      "Hidden": false,
      "GrantedToClasses": []
    },
    {
      "Name": "Tradeband",
      "Description": "A common language for ease of trade across regions",
      "Prefix": "tr",
      "Syllables": ["feng", "tar", "kin", "ga", "shin", "ji"],
      "Color": "#D4A96A",
      "Default": false,
      "Hidden": false,
      "GrantedToClasses": []
    },
    {
      "Name": "Ancient",
      "Description": "A mysterious ancient language",
      "Prefix": "anc",
      "Syllables": ["xar", "eth", "oth", "ith", "uth", "yth"],
      "Color": "#8B0000",
      "Default": false,
      "Hidden": true,
      "GrantedToClasses": ["malefactor"]
    }
  ],

  // ----- Nametags ----- //
  "PreventProximityChannelSwitching": true,
  "ShowNicknameInNametag": true,
  "HideNametagUnlessTargeting": false,
  "ShowPlayerNameInNametag": true,
  "NametagRenderRange": 30,

  // ----- OOC Chat ----- //
  "AllowOOCToggle": true,
  "OOCTogglePermission": "chat"
}

System Details

TPA (Teleport) System

The TPA system allows players to request teleportation to other players. Key features:

• Requires a temporal gear by default (configurable)
• Optional cooldown system
• Permission-based access
• Request/accept/deny workflow for safety

Language System

The language system allows players to learn and use different languages for roleplay. Key features:

• Players can learn languages using /addlang [language] and remove them with /remlang [language]
• To speak in a language, prefix your message with `:lang`, such as `:c` or `:tr`. Use the language identifier without a message to set your current default speaking language.
• Players are limited to knowing a maximum number of languages at once (configurable, default 3)
• Languages can be hidden from players to prevent unauthorized access
  • Hidden languages can only be added by admins using /adminaddlang
  • Admins can see all languages (including hidden ones) with /adminlistlang
• Players who don't know any languages or try to speak in an unknown language will "babble" incoherently
• Languages can be configured with `GrantedToClasses` to automatically be given to players based upon their class.

Player Stats System

Tracks various player statistics including:

• Deaths
• Player kills
• NPC/Mob kills
• Blocks broken
• Distance travelled

Server Save Notification

Automatically notifies players when the server is saving, helping reduce confusion about temporary lag spikes. The notification messages and timing are fully configurable.

Sleep Notification System

Encourages coordinated sleeping by notifying players when enough others are in bed. This helps servers manage the day/night cycle more effectively.

Potential Future Improvements

• Use actual line of sight for sign language

Feel free to leave suggestions! Thank you for your continued support and for being a part of the amazing VS roleplaying community!