https://github.com/redocinortyc/sheriff
Sheriff is the official Discord bot for the International Junior Honor Society, and maintained by the whole IJHS community
https://github.com/redocinortyc/sheriff
bot discord discord-bot discord-js discordjs nodejs
Last synced: over 1 year ago
JSON representation
Sheriff is the official Discord bot for the International Junior Honor Society, and maintained by the whole IJHS community
- Host: GitHub
- URL: https://github.com/redocinortyc/sheriff
- Owner: redocinortyC
- License: gpl-3.0
- Created: 2022-02-02T02:23:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T09:05:04.000Z (over 3 years ago)
- Last Synced: 2023-03-18T18:23:33.931Z (over 3 years ago)
- Topics: bot, discord, discord-bot, discord-js, discordjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 594 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## About
Sheriff is a multipurpose Discord bot that utilizes [Node.js](https://nodejs.org) and the
[Discord API](https://discord.com/developers/docs/intro). It is also the official Discord bot for the International Junior Honor Society (IJHS). It is owned by [Cytronicode](mailto:novodoodle@gmail.com), but it is maintained by the whole IJHS community.
- Multipurpose
- Community maintained
- 100% slash command-based
See [the features guide](https://github.com/cytronicode/sheriff/blob/main/features.md) if you'd like to get a glimpse into what Sheriff is capable of!
## Features
### Experimental commands
- Bot reactions
### Moderation commands
- Kick
- Ban and unban
### Role commands
- Add/give role
### Utility commands
- Ping
### Fun commands
- Cryptocurrency data
### Info commands
- About IJHS
- About the SLC
- About the committees
## Cloning the repository onto your local system
**Node.js 16.9.0 or newer is required.**
```sh-session
$ git clone https://github.com/Cytronicode/sheriff.git
```
Note that if you want to base your own bot off of this repository, you need to rename the `config-example.json` file to `config.json` and add the guild ID and client ID. Additionally, note that **the bot token is an environment variable**, so there is also a need for you to create a local `.env` file.
## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested.
See [the contribution guide](https://github.com/cytronicode/sheriff/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.