Discord Auth is a simple plugin allows players to connect their discord account with steam.
Permissions
- discordauth.auth -- Required for the authenticate command
- discordauth.deauth -- Required for the deauthenticate command would recommend not giving this permission to the default group
Commands
This plugin provides universal chat and console commands. When using a command in game chat, prefix it with a forward slash: /
.
auth
-- Generates a code which players can send to the botdeauth
-- Deauthenticates the player
Configuration
{
"Settings": {
"Bot Token": "",
"Discord Server ID (Optional if bot only in 1 guild)": "",
"Auth Commands": [
"auth",
"authenticate"
],
"Deauth Commands": [
"deauth",
"deauthenticate"
],
"Oxide Groups to Assign": [
"authenticated"
],
"Discord Roles to Assign": [
"DiscordAuth"
],
"Revoke Oxide Groups on Deauthenticate": true,
"Revoke Discord Roles on Deauthenticate": true,
"Automatically Reauthenticate on Leaving and Rejoining the Discord Server": true,
"Automatically Deauthenticate Non Active Players": false,
"Player Considered Non Active After (Days)": 30.0,
"Discord Extension Log Level (Verbose, Debug, Info, Warning, Error, Exception, Off)": "Info"
},
"Authentication Code": {
"Code Lifetime (minutes)": 60,
"Code Length": 5,
"Code Case Insensitive Match": true,
"Code Characters": "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
}
}
Localization
{
"Chat Format": "[#1874CD](Auth)[/#]: {0}",
"Code Generation": "Here is your code: [#1874CD]{0}[/#]\nJoin our [#EE3B3B]Discord[/#] and PM the code to the Discord Bot",
"Code Expired": "Your code has [#EE3B3B]Expired![/#]",
"Authenticated": "Thank you for authenticating your account",
"Game-Deauthenticated": "Successfully deauthenticated your account",
"Discord-Deauthenticated": "You have been deauthenticated from {0}",
"Discord-Deauthenticated-NonActive": "You have been deauthenticated from {0} because you haven't been active on the game server for {1} days",
"Already Authenticated": "You have already [#1874CD]authenticated[/#] your account, no need to do it again",
"Not Authenticated": "You are not authenticated",
"Group Revoked": "Your '{0}' Server Group(s) have been revoked! Reauthenticate to receive it",
"Roles Revoked": "Your '{0}' Discord Role(s) have been revoked! Reauthenticate to receive it",
"Join Granted": "Granted '{0}' Group(s) and '{1}' Discord Role(s)",
"Rejoin Granted": "Granted '{0}' Group(s) and '{1}' Discord Role(s) for joining {2} back",
"Unable to find code": "Sorry, we couldn't find your code, please try to authenticate again, If you haven't generated a code, please type /auth in-game",
"No Permission": "You dont have permission to use this command"
}
Developer API
Link information is provided by the Discord Extension Link API:
FAQ
Q: Where can I get the bot token?
A: Please follow the steps on Discord Extension Getting Started to get your bot token.
Q: Am I required to host the Discord Bot?
A: No. It doesn't require the bot to be hosted. The bot is handled and ran from the Discord Extension.**
Q: How does it work exactly?
A: Players can generate a code in game with the authenticate command which they can DM to the bot directly. This will add them to the Discord Extension Link Data, configured Oxide Groups, and configured Discord Roles.
Credits
Tricky The original plugin author
OuTSMoKE Current Maintainer
MJSU Assistant Maintainer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.