-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
83d6cc8
commit 3efdfe1
Showing
1 changed file
with
93 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,114 @@ | ||
| # SponsorBoi | ||
| # SponsorBoi [](https://jenkins.karlofduty.com/blue/organizations/jenkins/SponsorBoi/activity) <!--[](https://github.com/KarlOfDuty/SponsorBoi/releases)--> [](https://github.com/KarlOfDuty/SponsorBoi/releases) [](https://discord.gg/C5qMvkj) | ||
| A Discord bot which syncs Github Sponsors to Discord. | ||
|
|
||
| Discord users may register their Github accounts using bot commands and they can be granted roles depending on their sponsorship tiers via the Github API. | ||
|
|
||
| The bot works by having the user create an issue in one of your repositories containing their Discord ID, then run the link command in your Discord server. The bot then checks the most recent issues of the repo for the ID and links the Github user with the Discord user when it is found. | ||
|
|
||
| The user is then granted a role according to your config and the bot will re-check all linked users every two hours (by default) to make sure they are still a sponsor. If a user unlinks themselves they also lose their sponsor role until they re-link. If a linked user re-joins the Discord server they will retain their role. | ||
|
|
||
| ## Commands | ||
|
|
||
| | Command | Description | | ||
| |--- |---- | | ||
| | `link` | Links your Discord account to your Github account. | | ||
| | `link <discord user> <github user>` | Manually links a Discord account to a Github account. | | ||
| | `unlink` | Unlinks your Github account. | | ||
| | `unlink <discord user>` | Unlinks a user's Github account. | | ||
| | `recheck` | Forces a recheck of all linked users' sponsor status. | | ||
| | `recheck <discord user>` | Forces a recheck of a specific user's sponsor status. | | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Set up a mysql server, create a user and empty database for the bot to use. | ||
|
|
||
| 2. [Create a new bot application](https://discordpy.readthedocs.io/en/latest/discord.html). | ||
|
|
||
| 3. Download the bot for your operating system, either a [release version](https://github.com/KarlOfDuty/SponsorBoi/releases) or a [dev build](https://jenkins.karlofduty.com/blue/organizations/jenkins/SponsorBoi/activity). | ||
|
|
||
| 4. Run `./SponsorBoi` on Linux or `./SponsorBoi.exe` on Windows, the config is created for you. | ||
|
|
||
| 5. Set up the config (`config.yml`) to your specifications, there are instructions inside and also further down on this page. If you need more help either contact me in Discord or through an issue here. | ||
|
|
||
| ## Config: | ||
| ```yaml | ||
| github: | ||
| # Github personal access token - https://github.com/settings/tokens - Requires user read permissions to fetch sponsors. | ||
| # Github personal access token - https://github.com/settings/tokens - Requires 'read:org' permission (and maybe 'read:user'?) to fetch sponsors. | ||
| token: "<add-token-here>" | ||
| # Amount of time in minutes between each refresh, it is recommended to keep this above 5 minutes. | ||
| update-rate: "15" | ||
|
|
||
| # Amount of time in minutes between re-checking users with registered roles, recommended to keep high. | ||
| auto-prune-time: 120 | ||
|
|
||
| sync: | ||
| # The name of the repository to check for verification requests, must be owned by the same user as the token above. | ||
| repository-name: "MyRepo" | ||
|
|
||
| # The user is shown this url when they run the sync command. | ||
| # It is recommended that you set up an issue template with instructions for the user and link directly to it here. | ||
| # You can enable issue templates in your repository settings under 'Options->Issues->Set up Templates'. | ||
| issue-url: "https://github.com/MyUsername/MyRepo/issues/new/choose" | ||
|
|
||
| bot: | ||
| # Bot token. | ||
| token: "<add-token-here>" | ||
| # Decides what messages are shown in console, possible values are: Critical, Error, Warning, Info, Debug. | ||
| console-log-level: "Info" | ||
|
|
||
| # Command prefix. I recommend setting it to something like "+sponsor " if you have other bots that might need the single character prefix. | ||
| prefix: "+" | ||
|
|
||
| # Decides which messages are shown in console | ||
| # Possible values are: Critical, Error, Warning, Information, Debug. | ||
| console-log-level: "Information" | ||
|
|
||
| # A list of the dollar amount of the sponsorship tiers paired with corresponding role ids. | ||
| roles: | ||
| - "10": "111111111111111111" | ||
| - "5": "222222222222222222" | ||
| - "1": "333333333333333333" | ||
| - "10": "000000000000000000" | ||
| - "5": "111111111111111111" | ||
| - "1": "222222222222222222" | ||
|
|
||
| # Sets the type of activity for the bot to display in its presence status. | ||
| # Possible values are: Playing, Streaming, ListeningTo, Watching, Competing. | ||
| presence-type: "Watching" | ||
|
|
||
| # Sets the activity text shown in the bot's status. | ||
| presence-text: "for new sponsors" | ||
|
|
||
| # Your Discord server's ID | ||
| server-id: 430468637183442945 | ||
|
|
||
| # Set up which roles are allowed to use different commands. | ||
| # Example 1: | ||
| # self: [ 000000000000000000, 111111111111111111 ] | ||
| # Example 2: | ||
| # self: | ||
| # - 000000000000000000 | ||
| # - 222222222222222222 | ||
| # Do not give non-staff roles access to execute commands on other users. | ||
| permissions: | ||
| # Saves a discord user's Github account in the database. | ||
| link: | ||
| self: | ||
| - 000000000000000000 | ||
| - 111111111111111111 | ||
| other: | ||
| - 222222222222222222 | ||
| # Removes a user's linked Github account. | ||
| unlink: | ||
| self: | ||
| - 000000000000000000 | ||
| other: | ||
| - 222222222222222222 | ||
| # Manually rechecks a user's sponsor status | ||
| recheck: | ||
| - 222222222222222222 | ||
|
|
||
| database: | ||
| # Address and port of the mysql server | ||
| # Address and port of the mysql server. | ||
| address: "127.0.0.1" | ||
| port: "3306" | ||
| # Name of the database to use | ||
| # Name of the database to use. | ||
| name: "sponsorboi" | ||
| # Username and password for authentication | ||
| # Username and password for authentication. | ||
| user: "username" | ||
| password: "password" | ||
| ``` | ||
|
|
||
| ``` |