Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan6erbond/reddify
Reddit verification bot for Discord with useful statistics and an intuitive verification process.
https://github.com/dan6erbond/reddify
discord-bot discord-py python reddit
Last synced: 18 days ago
JSON representation
Reddit verification bot for Discord with useful statistics and an intuitive verification process.
- Host: GitHub
- URL: https://github.com/dan6erbond/reddify
- Owner: Dan6erbond
- License: gpl-3.0
- Created: 2020-07-12T09:53:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-08T17:19:25.000Z (about 3 years ago)
- Last Synced: 2024-10-11T12:47:47.676Z (about 1 month ago)
- Topics: discord-bot, discord-py, python, reddit
- Language: Python
- Homepage:
- Size: 117 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reddify
Reddify is the open-source rework of the original Reddify bot. It makes use of [aPRAW's](http://apraw.readthedocs.io/) asynchronous functionality, Discord.py as well as a SQLite3 database to enable a seamless connection between Discord and Reddit.
## Contents
- [Reddify](#reddify)
- [Contents](#contents)
- [Usage](#usage)
- [Admin Setup](#admin-setup)
- [Verification](#verification)
- [Commands](#commands)
- [Community and Support](#community-and-support)
- [Contributing](#contributing)
- [License](#license)
## Usage
Reddify is a public bot hosted by Dan6erbond and can be invited to any public server via its [invite link](https://discord.com/oauth2/authorize?client_id=555093732010229760&scope=bot). Upon invitation, guild administrators can use the commands available to configure the bot and should also consider disabling members from changing their nickname if they wish for all of the nicknames to follow the "/u/" convention.
### Admin Setup
Guild admins can use the following commands to configure Reddify:
- `!toggle `: Based on the selection of either role, username or nick, the feature will be toggled on or off.
- **role:** Creates a role in the guild that is assigned to members who have verified their Reddit account.
- **username:** Automatically sets members' usernames to the format of "/u/" after the verification process has been completed.
- **nick:** Allows members to use the `!nick ` command to change the guild nickname to " (/u/)".
- `!setguildsub `: Sets the subreddit that stats will be fetched for in the guild if no argument is passed to `!substats`.
- `!setchannelsub `: Sets the subreddit that stats will be fetched for in the channel if no argument is passed to `!substats`.
- `!status`: Shows the current status of the bot's configuration in the guild.
### Verification
Users of the Reddify bot can connect as many Reddit accounts as they wish to a single Discord account. The process is very straightforward:
1. Initiate the process with the `!verify ` command.
2. Respond to the message sent by the bot with `verify`.
3. Wait until a checkmark appears on the bot's message in Discord, and the verification is complete!
To undo the verification or if the bot might have missed the `verify` message on Reddit, the `!unverify ` command can be used. If any errors are found, an issue can be created on GitHub or the developer directly contacted on Discord.
### Commands
Besides verification and server setup, there are a couple commands that help connect Reddit and Discord via Reddify:
- `!me`: Displays all your (un)verified accounts.
- `!nick `: Sets a nickname before the "/u/" part if the feature has been enabled in the guild.
- `!stats `: Displays the stats of a user's linked accounts.
- `!substats :` Displays the stats of a subreddit.
## Community and Support
Reddify is actively being maintained and you're always free to join the [Mariavi](https://img.shields.io/discord/554773624784027658?color=7289da&label=Discord&logo=discord&style=flat-square) or [Dan6erbond](https://discord.gg/wMEyKZk) Discord servers to chat about it. Also consider joining the [aPRAW Discord server](https://discord.gg/66avTS7) which has made the implementation of Reddify possible in the first place and contributions to either projects are always welcome!
### Contributing
As Reddify is open-source under the GPLv3 license, all additions and bug reports in the form of issues and pull requests are welcome! Have fun coding!
## License
Reddify's source is provided under GPLv3.
> Copyright ©, RaviAnand Mohabir