Documentation
User guide for USMAN Bot
Get started in 4 steps
- Add the bot to your server with the “Add to Discord” button. It automatically receives the permissions it needs (a “USMAN Bot” role created by Discord). You must have “Manage Server” on that server.
- Log in to the panel with Discord, then pick your server from the list (only servers where the bot is present and where you manage the server appear).
- Fill in VRChat: the bot’s dedicated account and the group ID (“VRChat” module).
- Choose your channels and roles in the menus, then click “Save”. The new settings are applied within seconds.
The panel
The sidebar lists the modules. Your changes stay as a draft until you click “Save” (bar at the bottom of the page). Passwords and secrets you enter are never displayed again: a badge only shows that they are saved. To switch servers, use the selector at the top of the sidebar.
Modules
| Module | What it does |
|---|---|
| Ban list | Channel where the bot keeps a single message with the group’s banned users, updated automatically, with paging through reactions ⏮️ ⬅️ ➡️ ⏭️. Temporary bans show their remaining time. Titles and texts follow the server’s language. Set the number per page and the refresh rate. |
| Group logs | Every action of the VRChat group (bans, roles, invitations…) is posted in a channel. Actions made with the bot’s commands are also noted there, with the Discord member who made them. |
| Instances | Alerts in a channel when a group instance opens; can also publish a post on the VRChat group (custom title and text, anti-spam delay). |
| Moderators and members | Two channels with the list of the group’s moderators and the list of members, kept up to date. |
| Permissions | Choose which Discord roles can use /ban, /tempban, /unban and /mod. Server administrators are not automatically allowed: add their role if needed. |
| VRChat | Dedicated account, group ID (grp_…), moderator role to assign, optional 2FA secret, 2FA code entry if VRChat asks for it. |
| Data and privacy | Export all your data, delete everything, or make the bot leave. |
Discord commands
| Command | Effect |
|---|---|
/ban <username> [reason] | Permanently bans the player from the VRChat group. |
/tempban <username> <duration> [reason] | Bans the player temporarily: they are unbanned automatically when the duration ends. |
/unban <username> | Unbans the player (and cancels their temporary ban, if any). |
/mod add <username> | Gives the group moderator role to the VRChat player. |
/mod remove <username> | Removes that role. |
/vrchat status | Shows the state of the VRChat account connection. |
/vrchat roles | Lists the group’s roles and their IDs. |
/vrchat code <code> | Enters the 2FA code requested by VRChat. |
/tempban duration
The duration is a number followed by a unit: s = seconds, m = minutes, h = hours, d = days. Examples: 30m (30 minutes), 12h (12 hours), 7d (7 days), 1h30m (1 h 30). Minimum 10 seconds, maximum 365 days. The unban is automatic, even if the bot restarted in the meantime. Using /ban on a temporarily banned player makes the ban permanent.
Command language
Command names, options and replies are shown in the language of your Discord app (English, French, Spanish or Chinese, English by default). The bot’s logs and messages in the server follow the server’s language.
These commands are reserved for the roles you chose in “Permissions”. Every action is recorded in the logs channel.
VRChat account
- Create a dedicated VRChat account for the bot and add it to your group with a role that has the useful permissions (view bans, manage bans, manage roles, view logs…). Without them, VRChat answers “You don’t have permission”.
- The group ID looks like
grp_xxxxxxxx-xxxx-…(in the address of the group page on vrchat.com). - If the account uses app-based two-factor authentication, paste its TOTP secret in the panel: the bot will generate the codes itself. Otherwise, enter the code you receive when the panel asks for it.
- The service uses the unofficial VRChat API: excessive use may be limited by VRChat. The minimum intervals are therefore capped.
Your data
See the privacy policy. In short: only what is necessary is stored, secrets are encrypted, everything is deleted when you remove the bot, and the “Data and privacy” module lets you export or erase at any time.
Common problems
My server does not appear in the list
The bot must be on the server and you must have “Manage Server”. Log out and log back in to refresh the list.
“You don’t have permission” in the ban list
The bot’s VRChat account does not have the role or permissions it needs in the group.
The commands do not appear
Re-invite the bot with the “Add to Discord” button (the applications.commands scope is required), then wait a minute.
The bot does not write in a channel
Check that its role can see the channel and send messages and embeds there. Channels without this permission are flagged in the menus.
The panel asks for a 2FA code
VRChat sent a code by e-mail or app: enter it in the “VRChat” module.
Need help? Join our Discord server or write to [email protected].