Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nulldev/discord-roleshop
Discord Bot for a Roleshop with currency that can be earned by writing messages.
https://github.com/nulldev/discord-roleshop
bot discord-bot discord-js javascript nulldev shop
Last synced: 2 months ago
JSON representation
Discord Bot for a Roleshop with currency that can be earned by writing messages.
- Host: GitHub
- URL: https://github.com/nulldev/discord-roleshop
- Owner: NullDev
- License: apache-2.0
- Created: 2023-04-30T02:42:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-18T09:32:45.000Z (7 months ago)
- Last Synced: 2024-10-15T01:07:36.704Z (3 months ago)
- Topics: bot, discord-bot, discord-js, javascript, nulldev, shop
- Language: JavaScript
- Homepage:
- Size: 15.2 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord-RoleShop
[](https://github.com/NullDev/Discord-RoleShop/actions/workflows/cd.yml) [](https://github.com/NullDev/Discord-RoleShop/blob/master/LICENSE) [](https://github.com/NullDev/Discord-RoleShop/issues?q=is%3Aissue+is%3Aclosed)
Discord Bot for a Roleshop with currency that can be earned by writing messages.
## :question: What does it do?
User earn points by writing messages. With those points, they can purchase special roles from a built-in shop.
## :satellite: Invite the bot
[](https://discordapp.com/oauth2/authorize?client_id=1102551839674740737&scope=bot&permissions=1099780064256)
The link above will invite a bot hosted by me that uses the latest version of this repo.
Alternatively you can host the bot yourself. Instructions [below ⏬](#wrench-setup)
## :star: Features
- [x] Earn points by writing messages
- [x] Spend points in a built-in shop
- [x] Customizable shop
- [x] Random gifts
- Can be disabled
- Cooldown can be set
- Chance can be set
- [x] Optional multiplier for server boosters [Default: 2x]
- Can be set on every Discord server individually
- [x] Slash commands
- [x] Admin commands
- [x] User commands
- [x] Translations
- [x] Multi-language support (Can be set on every Discord server individually)
- English (Peer reviewed ✅)
- German (Peer reviewed ✅)
- [x] Easy to set up (Check [below](#wrench-discord-bot-setup-for-server-admins))
- Invite bot
- Add roles to the shop (`/rs-add-role`)
- Remove roles from the shop (`/rs-remove-role`)
- Add role icons to the shop (`/rs-set-role-icon`)
- [OPTIONAL] Set server language (`/rs-set-language`) [Default: English]
- [OPTIONAL] Set or disable booster multiplier (`/rs-set-multiplier`) [Default: 2x]
- [OPTIONAL] Toggle the spam filter (`/rs-spam-filter`) [Default: Enabled]
- [OPTIONAL] Toggle and configure random gifts (`/rs-random-gift`) [Default: Enabled, Cooldown: 4hours, Chance: 5%]
- [x] Easy to self-host
- No external database needed
- Easy configuration system
- Install instructions provided [below](#wrench-dev-setup)
- [x] Admin-only commands
- [x] Fail-safes to prevent point loss on error
- [x] Automatic Syncing to keep up with DB and Discord states
- [x] _Smart Spam Filtering™_ via Exponential Smoothing & Moving Average
- [x] Transaction log
- [x] Leaderboard
- [x] Ban / Unban users from using the bot
## :diamond_shape_with_a_dot_inside: Feature requests & Issues
Feature request or discovered a bug? Please [open an Issue](https://github.com/NullDev/Discord-RoleShop/issues/new/choose) here on GitHub.
## :wrench: Discord Bot Setup for server admins
**Setup**:
- [Invite](https://img.shields.io/badge/Invite-37a779?style=for-the-badge) the bot.
- Add roles to the shop (`/rs-add-role`)
- ATTENTION: Make sure the bots role `roleshop` is above the roles you added to the shop! (Server Settings -> Roles -> Drag the bots role above the roles you added to the shop)
- Remove roles from the shop (`/rs-remove-role`)
**Admin Commands**:
- Set a role icon which will be displayed in the shop (`/rs-set-role-icon`)
- Set server language (`/rs-set-language`) [Default: English]
- Set or disable booster multiplier (`/rs-set-multiplier`) [Default: 2x]
- Toggle the spam filter (`/rs-spam-filter`) [Default: Enabled]
- Toggle and configure random gifts (`/rs-random-gift`) [Default: Enabled, Cooldown: 4hours, Chance: 5%]
- Reset ALL server stats (`/rs-reset-all`)
- Set the points of a user (`/rs-set-points`)
- View the current transaction log (`/rs-transaction-log`)
- List all registered roles (`/rs-list-roles`)
- Show admin help (`/rs-admin-help`)
**User Commands**:
- View the shop (`/rs-shop`)
- View your or another users points (`/rs-stats`)
- Show the top 10 users with most points (`/rs-top`)
- Return a role you bought from the shop (`/rs-return`)
- Show user help (`/rs-help`)
- Shop bot info (`/rs-info`)
## :wrench: Dev Setup
0. Open up your favourite terminal (and navigate somewhere you want to download the repository to).
1. Make sure you have NodeJS installed (>= v20.0.0). Test by entering
$ `node -v`
If this returns a version number, NodeJS is installed. **If not**, get NodeJS here.
2. Clone the repository and navigate to it. If you have Git installed, type
$ `git clone https://github.com/NullDev/Discord-RoleShop.git && cd Discord-RoleShop`
If not, download it here and extract the ZIP file.
Then navigate to the folder.
3. Install all dependencies by typing
$ `npm install`
4. Copy [config/config.template.js](https://github.com/NullDev/Discord-RoleShop/blob/master/config/config.template.js) and paste it as `config/config.custom.js`
5. Configure it in your favourite editor by editing `config/config.custom.js`. OR use `npm run generate-config`
6. Start it in development mode by running
$ `npm start`
or start in production mode
$ `npm run start:prod`
## :nut_and_bolt: Configuration
Once the config has been copied like described in [Step 4](#wrench-setup), it can be changed to your needs:
```js
{
discord: {
bot_token: "", // Auth Token of the Discord bot. Can be created here: https://discordapp.com/developers/
bot_status: "Usage: /rs-help", // Bot activity ala "Is playing..."
},
bot_settings: {
slash_command_prefix: "rs", // Prefix for all slash commands. e.g. `/rs-foo`, `/rs-bar`.
spam_filter: {
alpha: 0.4, // The smoothing factor for the expavg spam filter (smaller = stricter)
window: 5, // The window for the moving average (last `n` messages) for calculation
},
emote_server_id: "", // Server for uploading role icons to be displayed in shop
},
}
```
## :octocat: Contributors
Made with [contrib.rocks](https://contrib.rocks).