-
Notifications
You must be signed in to change notification settings - Fork 0
2. Setup Discord
Invite the UdonVR bot to your server by going into the UdonVR server,
clicking on the bot in the Users list under Admin
, and hitting Add To Server
.
To start using the bot, run the /Setup
command.
Make sure to do this in your server.
Make sure the person who's subscribed is running /setup
!
The person who runs this command will be marked as the server's owner and used for permission checking.
You can change this later with this command [TBD].
There's a whole command reference in the "Discord Commands" doc, and they should also be displayed in Discord too.
The commands can be ran by anyone with the Server Manager
permission or higher.
After setting up the bot and receiving confirmation that your server is active please sign into DisBridge.com using your Discord account.
Your server should show up in your list of servers, but if it doesnt show up after a page refresh, please message @childofthebeast via Discord.
Use /set-log-channel [channel]
to setup a log channel.
By Default, the log channel logs when:
- A user gets invited.
- A user fails to get invited.
- A server upload gets queued.
- An upload completes.
- An upload gets removed.
All these can be configured in your log options menu.
NOTE: Make sure the bot has the Embed Links
permission in the selected channel.
Default permission rank |
command | description |
---|---|---|
Manage Server | /set-log-channel [channel] |
Sets a log channel to use. |
Manage Server | /log-options-menu |
Shows the log options menu. |
Use /set-invite-channel
[channel]
to setup an invite channel.
By Default the bot creates Private Threads in the invite channel for each user. You can set the bot to add roles or members to these threads. It's recommended to add a staff role to these in case anyone needs help linking their accounts.
NOTE: Make sure the bot has the Embed Links
permission in the selected channel.
Default permission rank |
command | description |
---|---|---|
Manage Server | /set-invite-channel [channel] |
Sets what channel should be used for in-server invites. By default private threads are used. |
Manage Server | /inviteoptions |
Allows you to set options for the invite channel. |
ADDING ROLES TO THE BOT WILL START DMING PEOPLE ASKING THEM TO LINK THEIR ACCOUNT.
MAKE SURE YOU MAKE AN ANNOUNCEMENT BEFORE HAND TELLING YOUR USERS ABOUT THIS!!
The bot will DM anyone new that has been added to our database.
We don't collect any data off of these accounts other than already Public information.
The only data we collect and store is the public VRChat Username of the user,
the public VRChat account ID and the public Discord Account ID.
We do not store or collect anything other than already public information that is needed to check for VRChat Usernames and link them to Discord IDs.
If you are adding a role that already has users in it, make sure to run /check-supporters
for the bot to see those users.
Default permission rank |
command | description |
---|---|---|
Manage Server | /check-supporters |
Checks your server for Role changes or User changes. This does not force your server to upload, just queues a check. |
Manage Server | /list-supporters |
list the users who should be included and their link status. |
Manage Server | /supporter-role add [role] |
adds a role to the list of roles to be included. |
Manage Server | /supporter-role remove [role] |
removes a role from the list of roles to be included. |
Manage Server | /supporter-role list |
lists all of your included roles. |
Manage Server | /supporter-role reorder |
lets your reorder the list of included roles. |
The commands input can only be seen by the user inputting them and will now get sent to the channel.
When you add your roles to the bot, you can view them with /supporter-role list
or /guild-status
.
Your roles will be assigned an ID when added. This ID is used to track what roles go where in your world.
It is recommended to use the website for this now.
List Supporters will list all of the current users that the bot is tracking for your server.
It'll show 3 Emoji, the first one is current Linked status, the 2nd is if they have a currently uploaded role, and the 3rd is if they're going to be included with the next upload.
You can reference the list below to get a breakdown of what each emoji means.
The next 2 listed things are the Discord account of the user, and the name that will used next upload.
Emoji | Description |
---|---|
Has a role that's included in the upload list | |
Does Not have a role that's included in the upload list | |
Not currently linked, and not invited (Usually this shows up when the user has DMs off) |
|
The user has been invited but is not linked | |
The user is linked | |
The user will be included with the next Upload | |
The user will not be included with the next Upload |
When you run Role Reorder it'll list your roles with the current order and give you a Drop Down Menu.
To reorder your roles click on the Drop Down menu, and select all the roles in the order that you want to be in.
The order in the bottom on the Drop Down will NOT list them in the order that you selected them. This is normal.
When you selected all your roles, click out of the Drop Down. You'll be presented with your new order and confirmation Yes/No buttons.
Confirm this is how you wanted your roles ordered then hit Yes
, your role order will then be saved.
We don't collect any data off of your VRChat account other than already Public information.
The only data we collect and store from VRChat is the public VRChat Username of the user, and the public VRChat account ID.
We do not store or collect anything other than already public information that is needed to check for VRChat Usernames and link them to Discord IDs.
command | description |
---|---|
/vrclink profile [Profile URL] |
Uses an Account URL to link your accounts. |
/vrclink userid [Profile ID] |
Uses an Account ID to link your accounts. |
/vrclink username [Username] |
Uses a Username to link your accounts. |
The commands input can only be seen by the user inputting them and will not get sent to the channel.
These commands can be used by anyone in any channel the bot is in, including DMs.
Running /guild-status
will display a bunch of information about how your bot is setup.
You're key will be at the bottom of Guild Status, and you can export your server's Json with the button labeled "Get Json".
You can save this file anywhere, it doesn't need to be in your Unity project folder.