Mod Mail

Mod Mail 1.0.0

Sign in to download
Provides an in-game mailbox system for players to contact admins
Documentation License Version History Discussion
This plugin allows players to contact admins by submitting in-game mail. Players can write a note, store it in a temporary mailbox, and send it. Admins can review all messages in an archive and receive notifications in-game and on Discord.






Permissions

  • modmail.use - Allows a player to send mail.
  • modmail.admin - Allows an admin to open the mail archive.

Commands

  • /sendmail - Opens a temporary mailbox where the player can submit a message.
  • /openmail - Opens the admin mail archive, allowing review of all received messages.

Configuration

JSON: 
{
  "Version": "1.0.0",
  "Send Mail Chat Command": "sendmail",
  "Open Mail Archive Chat Command": "openmail",
  "Maximum Archive Capacity": 48,
  "Mail Cooldown Seconds": 60.0,
  "Discord Webhook Url": ""
}
  • Send Mail Chat Command - The chat command players use to submit mail.
  • Open Mail Archive Chat Command - The chat command admins use to view the mail archive.
  • Maximum Archive Capacity - The maximum number of stored messages. Older messages are removed when the limit is reached.
  • Mail Cooldown Seconds - The cooldown time before a player can send another mail.
  • Discord Webhook Url - The url for sending mail notifications to Discord. If empty, Discord notifications are disabled.

Stored Data

JSON: 
{
  "Mails": [
    {
      "Sender Name": "Player123",
      "Sender Id": 76561198000000000,
      "Timestamp": "2024-02-23T15:30:00Z",
      "Content": "Hello admin, I need help with my base."
    },
    {
      "Sender Name": "Player456",
      "Sender Id": 76561198000000001,
      "Timestamp": "2024-02-23T16:00:00Z",
      "Content": "Can you check on a cheater at my location?"
    }
  ]
}

Localization

JSON: 
{
  "NoPermission": "You do not have permission to use this command.",
  "MailboxCreateFail": "Failed to create mailbox!",
  "MailboxOpenPrompt": "Place your note in the mailbox to send to admins.",
  "MailArchiveCreateFail": "Failed to create the mail archive container!",
  "MailArchiveOpenPrompt": "Opening the mail archive. Feel free to read or take any notes.",
  "MailSent": "Thanks! Your note has been sent to the admins.",
  "EmptyNote": "Your note is empty. Please type something before sending.",
  "NewMailAlert": "New mail received from {0}. Use /openmail to view the archive.",
  "DiscordMailAlert": "From: {0} ({1})\nTime: {2}\n```{3}```",
  "MailCooldown": "Hold up! You cannot send another mail yet."
}
Author
VisEntities
Downloads
18
First release
Last update

Ratings

0.00 star(s) 0 reviews
Donate Contribute on GitHub

Also by VisEntities

  • Lucky Barrel
    Lucky Barrel
    Place a storage barrel, and with a bit of luck, it might turn into a random loot barrel
  • Silent Building Blocks
    Silent Building Blocks
    Removes the smoke effect when placing building blocks
  • Kill Awards
    Kill Awards
    Gives players rewards for every set number of kills
Back
Top
This plugin uses Oxide's permission system. Grant or revoke permissions using oxide.grant and oxide.revoke. You can assign them to individual players or groups using their Steam id or group name.
Chat commands start with a /, while console commands can be entered directly in the F1 console or server console. Use find <keyword> in console to search for available commands related to the plugin.
Settings are stored in the config file found under the config/ directory. You can edit this file manually, then reload the plugin to apply your changes.
Persistent data is saved in the data/ directory. This includes things like saved settings, usage stats, or player progress depending on the plugin. Deleting a data file will reset stored progress or customizations.
Language files are located in the lang/ folder. To translate messages, copy the en.json file into your target language folder (e.g. fr, de) and edit the values. Reload the plugin after changes to apply new messages.
This section lists public methods exposed by the plugin for use in other plugins. You can call these via the CallHook method. Make sure the plugin is loaded before calling its API to avoid null reference errors.
These are custom hooks that other plugins can listen for. Simply define a method with the same name and expected parameters in your plugin to handle the event. Hooks are triggered at key moments and are useful for extending or reacting to plugin behavior.
These hooks are injected into the game's code using Harmony. They let the plugin run code at key points in the game's internal logic. You can return values to block or modify behavior. Use with caution — these are powerful and can affect core mechanics.
Cart

Cart

Total -