About Admin Tools
Admin Tools is an all-in-one plugin designed to make your job as a server owner/admin easier. This plugin has a wide range of features and commands that allow you to control your server easily, both in-game and via Discord. It also adds custom quality of life features exclusive to this plugin!
★ Inventory Viewing System - View an NPC or player's inventory in Discord and in-game
★ Custom Combatlog System - View a player's combatlog in Discord and in-game
★ Backpack Viewing System - View a player's backpack (uMod plugin) in Discord
★ Custom ID System - Get the ID of players on your server quick and easy, copy directly from chat
★ Warn System - Inform players of their wrongdoings and keep track of them (Warn Visuals: UI, Chat, Chat + Toast/Gametip)
★ Watchlist System - Lets you put suspicious players on a list for you to monitor, logs in-game and to discord
★ Server Command System - Reload/load/unload plugins and other console commands in Discord and in-game
★ and more! (Rest of features below)
Quote/ban <player name or id> [reason] || Bans a player permanently. /unban <player name or id> || Un-bans a player. /kick <name or ID> [reason] || Kicks a player. /tempban <player name or id> <2h/5d/6w/1m/9y> [reason] || Temporarily bans a player for the specified time. /warn <player name or id> <reason> /removewarn <player name or id> <warn #> || Removes a player's warning. || (alias: /warnremove) /addwarn <player name or id> <reason> || Adds a warning to a player. || (alias: /warnadd) /clearwarns <player name or id> || Clears a player's warnings. || (alias: /warnclear) /watchlist active || Displays connected players on Watchlist. /watchlist players || Displays all players on Watchlist. /watchlist add <player name or id> <reason> || Adds a player to the Watchlist. /watchlist remove <player name or id> || Removes a player from the Watchlist. /rename <player name or id> <new name> || Changes a player's name to the inputted name. /resetname <player name or id> || Resets a player's name back to their steam name. /renamed players || Shows the list of renamed players. /renamed active || Shows the list of connected players who are renamed. /id <player name or id> || (alias: /playerid, /userid) /inventory view <player name or id> || Loot/view a player's inventory. /inventory backpack <player name or id> || Loot/view a player's inventory. /inventory clear <player name or id> || Clear a player's inventory. /inventory toggle || Toggle inventory viewing via RELOAD key. /permission grant user <player name or id> <permission> || Grants player a permission. /permission grant group <player name or id> <permission> || Grants group a permission. /permission revoke user <player name or id> <permission> || Revokes a player's a permission. /permission revoke group <player name or id> <permission> || Revokes a group's a permission. /load <plugin name> || Loads a plugin (if unloaded). /unload <plugin name> || Unloads a plugin (if loaded). /reload <plugin name> || Reloads a plugin. /fkill <name or id> || Force kill a player. || (alias: /slay, /murder) /wound <name or id> || Force wound (down) a player. || (alias: /fwound) /revive <name or id> || Force revive a wounded player. || (alias: /frevive) /fspawn <name or id> || Force spawn a player. || (alias: /frespawn, /forcespawn) /pop || Shows current pop. /players || Shows connected players. /teaminfo <name or id> || View a players team members. // RUST ONLY /creative <on/off> || Hold middle click to get the item you're looking at. /loot <player name or id> || Loot/view a player's inventory.
(Changed/Exclusive):
Quote/ban <player name or id> <reason> [2h/5d/6w/1m/9y] || Bans a player permanently OR temporarily. /tempban player <player name or id> <2h/5d/6w/1m/9y> <reason> || Temporarily bans a player for the specified time. /warn player <player name or id> <reason> || Warns a player with a UI. /warn remove <player name or id> <warn #> || Removes a player's warning. || (alias: /remove warn) /warn add <player name or id> <reason> || Adds a warning to a player. || (alias: /add warn) /warn clear <player name or id> || Clears a player's warnings. || (alias: /clear warn) /watchlist list || Displays all players on Watchlist. /renamed list || Shows the list of renamed players. /inventory view <player name or id> || View a player's inventory AND backpack (vanilla backpack). /kill <name or id> || Force kill a player. /respawn <name or id> || Force spawn a player. // DISCORD EXCLUSIVE /backpack view <player name or id> || View a player's backpack (plugin). /backpack clear <player name or id> || Clear a player's backpack (plugin). /npc view <npc name or id> || View an NPC's inventory. /npc clear <npc name or id> || Clear an NPC's inventory. /run <console command> || Run a command from discord in your console.
* Timestamps for video in video's description - Make sure to up video quality if watching from this site.
* Timestamps for video in video's description - Make sure to up video quality if watching from this site.
★ Permission System - Grant/revoke permissions to groups and players from Discord and in-game
★ Minecraft Creative System - While enabled, hold middle click to get the item you're looking at
★ Rename System - Rename the players who think they are funny (toggle in config)
★ F7 Report Logging System - Log F7 reports to discord with their combat log attached (if enabled)
★ Tempban System - Tempban players with no database required
★ Unique ID System - Find players even when they have the same or similar names -- Thanks to nivex 
★ Kill, Wound, Revive & Respawn System - Kill, wound (down), revive and respawn players from Discord and in-game
★ Team Viewing System - View a player's team members from Discord and in-game
QuoteFor copy prevention, hex and alpha values of inventory image and UI options removed. In your config they will be correct.
{ "Steam ID for messages to be sent from (aka profile picture, 0 for default Rust Icon)": 76561199682073328, "Hex Color for Syntax/Warned By in Lang": "#ff3d3d", "Hex Color for commands in the Syntax in Lang": "orange", "Hex Color for the user's name when copying.": "#FFA500", "Number of reports while plugin loaded before a player is added to the watchlist (0 is disabled, on unload player reports reset)": 0, "Reason to put on watchlist for players who have reached the report threshold": "Reached the threshold for F7's while plugin loaded.", "List of player IDs to exclude from F7 watchlist automation": ["Steam ID Here", "Another Steam ID Here"], "Use the custom combatlog for all players instead of default one (recommended for QoL)": true, "The steam ID of the owner to prevent kick/ban/tempbanning the user.": "Steam ID Here", "Enable /pop and /players commands": true, "Rename Options": { "Enable the rename system": true, "Allow players to rename themselves if they have rename permissions": false, "Renamed users will stay renamed after disconnecting": true }, "Warn Options": { "Warning system type (Options: 'UI', 'Chat', 'Toast').": "UI", "Play a sound when a warning appears on their screen.": true, "Path to the sound if its played.": "assets/bundled/prefabs/fx/beartrap/fire.prefab", "Options for Warn Thresholds.": { "Enable threshold warning system.": false, "Warn amounts before player gets kicked/banned/tempbanned. Key = Warn amount, Value = Action to take.": { "5": "Kick", "10": "Tempban", "25": "Ban" }, "Length of tempban when threshold met.": "5h" }, "Use Background Image": false, "Blur the background of the users screen": true, "The amount to blur the users screen (more alpha = more blur)": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Background Color": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Button Color": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Button Text Outline Color": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Font size of the message displayed": 22, "Background Image URL": "https://google.com/image.png", "Font size of the warning text displayed when Warning a user": 27, "Font size of the reason accompanying the Warning text": 22, "Seconds until the window automatically closes. (Only used if button to accept is false)": 0.0, "Top text displayed when Warning a User (Edit \"WarningText\" lang to have more control)": "WARNING", "Color of Top text displayed when Warning a User": "#000000", "Button to Accept the Warning (if false will use timer instead)": true, "The text in the button the user clicks to accept the warning (It needs to be somewhat short or wont fit)": "Acknowledge", "Size of the left side of the window in xMin, yMin order (the closer xMin is to the xMax, the smaller the window)": "0.3 0.35", "Size of the window in xMax, yMax order. (the closer yMin is to the yMax, the smaller the window)": "0.7 0.65" }, "Discord API Options": { "Discord API Functionality Enabled": false, "Discord Bot Token": "", "Discord Server ID (Optional if bot only in 1 guild)": "", "Discord Extension Log Level (Verbose, Debug, Info, Warning, Error, Exception, Off)": "Info", "Log Commands Sent by Users in-game": false, "Log Commands Sent by Users": { "Enabled": false, "Channel IDs": ["Channel ID here", "Second Channel ID here"] }, "Compact Logs": true, "Log F7 Reports": { "Enabled": false, "Channel IDs": ["Channel ID here", "Second Channel ID here"] }, "Send Combatlog with F7 reports": true, "Log to Discord when a Watchlisted player joins the server": { "Enabled": false, "Channel IDs": ["Channel ID here", "Second Channel ID here"] }, "Log to Discord when a player is banned from the server": { "Enabled": false, "Channel IDs": ["Channel ID here", "Second Channel ID here"] }, "Anonymize name of the person muting a player": { "Name to put instead of the players discord name": "Server", "ID to put instead of the players discord id (does not appear in chat)": "0", "Anonymity Enabled": false }, "List of commands to not allow in console via run command in discord": ["quit", "example command"], "Allow the following roles (Role IDs) to use ALL commands.": ["Role ID Here", "Second Role ID Here"], "Listen to commands from these channels (Channel IDs)": ["Channel ID Here", "Second Channel ID Here"], "NPC Inventory Viewing Options (default bounds includes all non-valid steam IDs)": { "Enable NPC Inventory Viewing in Discord": false, "Lower bound (inclusive) of the userID's to look for when checking bots/NPCs": 0, "Upper bound (inclusive) of the userID's to look for when checking bots/NPCs": 76561197960265728 }, "Page capacity of Backpacks from Backpacks Plugin, please make sure this matches for proper functionality/visuals": 48, "Size, in pixels, to save the item images. Image size for display is 100px, default save size is 70": 70, "Inventory Image Options": { "Inventory Image background color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory slots color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory active slot color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory text color and alpha for item/bullet/length/etc. count": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory panel color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory panel text color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory durability color and alpha": { "Hex": "#XXXXXX", "Alpha": 0.0 }, "Inventory durability background color and alpha (color in area where durability is lost)": { "Hex": "#XXXXXX", "Alpha": 0.0 } }, "Individual permissions for each command using Role IDs": { "ban": ["Role ID Here", "Second Role ID Here"], "ban.edit": ["Role ID Here", "Second Role ID Here"], "unban": [], "tempban": [], "tempban.player": [], "tempban.list": [], "kick": [], "mute": [], "unmute": [], "combatlog": [], "kill": [], "respawn": [], "wound": [], "revive": [], "run": [], "load": [], "unload": [], "reload": [], "allowrole": [], "revokerole": [], "permission": [], "permission.grant.user": [], "permission.grant.group": [], "permission.revoke.user": [], "permission.revoke.group": [], "plugins": [], "warn": [], "warn.clear": [], "warn.list": [], "warn.add": [], "warn.player": [], "warn.remove": [], "rename": [], "renamed": [], "resetname": [], "inventory.view": [], "inventory.clear": [], "backpack.view": [], "backpack.clear": [], "watchlist": [], "watchlist.add": [], "watchlist.remove": [], "watchlist.list": [], "watchlist.active": [], "pop": [], "players": [], "id": [], "info": [], "teaminfo": [], "help.admin": [], "help.warn": [], "help.watchlist": [], "help.general": [], "help.server": [], "help.other": [] } }, "Debug Mode (Only enable if you need to track errors and know what you're doing)": false, "Version": { "Major": 1, "Minor": 0, "Patch": 8 } }
Q: How do I set up the bot?
A: Set Up Instructions - If you miss any permissions, can always add them to the Admin Tools role in discord after you invite the bot.
Q: Does this plugin link players to Rust?
A: No. You can use the free plugin DiscordCore by MJSU if you would like to link your players.
Q: Does this plugin log kills/PMs/F1 Spawn/chat?
A: No. Admin Tools only logs the following if enabled: F7 Reports, Bans, commands from this plugin, and players who are watchlisted. You can always view a player's combatlog from discord though. You can use the free logging plugins DiscordLogger by MONoH or DiscordChat by MJSU depending on your goal. However, personally, I recommend against using logging functionality that would be occurring very frequently due to Discord's rate limiting. Though, DIscordLogger is made in a way that combines messages if possible to prevent limiting.
Q: Can this log to multiple Discord servers?
A: YES. All you need to put for logging to multiple servers is the channel ID you want to log to in the list of channel IDs in the config.
Q: Does this plugin ONLY work with Discord Extension 3.0.0+?
A: YES. You need to download the 3.0.0+ version from GitHub, it is linked at the top (and right here) as a required dependency. Any version prior to 3.0.0 will not work with this plugin, but any version 3.0.0 and later will.
Q: Will this work on a shared hosting server?
A: Yes, BUT you will not be able to take advantage of the threading done within the plugin. It should still work fine, but when you're on a shared host, you may only have access to a single core/thread (not positive on which) and as a result the threading I am doing in the plugin will just be ran on the main thread. As a result some of the discord functionality (ie: image generation) may affect the server as its now running on the main thread (what the server uses to run the game on) instead of a separate thread which would normally not affect the server. The image generation stuff (backpack and inventory) is normally pretty quick depending on number of items and pictures being used/sent, and can be between 100-250ms to generate on my server, however that was while no players were on.
Q: How do I fix this error Response Code: Forbidden Discord Error Code: 50001 Discord Error: Missing Access ?
A: All you need to fix this issue is MFA/2FA on the account used to create the bot. This issue is caused by Discord requiring your account to have either MFA or 2FA due to the bot being in a Community Discord server. After you add 2FA/MFA this error will go away.
Q: Renaming isn't working, how do I fix this?
A: The issue is likely that you don't have it enabled in the config, make sure to enable it in the config, its above the warning options and the discord API options.
Q: Can I forcibly update my bot's commands?
A: Sort of. You can do the following in an attempt to try and force the bot to update its commands:
Discord > Server Settings > Integrations > Admin Tools Bot > Toggle one of the checkboxes it shows in either Roles & Members or Channels > Save > Undo toggle > Save again.
- Special thanks to Nivex for creating the method used to generate unique IDs.
For support, please make a support ticket or join the Cobalt Studios Discord.
