{"id":16974685,"url":"https://github.com/nulldev/discord-roleshop","last_synced_at":"2025-08-03T12:15:16.491Z","repository":{"id":168730081,"uuid":"634408248","full_name":"NullDev/Discord-RoleShop","owner":"NullDev","description":"Discord Bot for a Roleshop with currency that can be earned by writing messages.","archived":false,"fork":false,"pushed_at":"2024-06-18T09:32:45.000Z","size":15922,"stargazers_count":3,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T22:22:44.671Z","etag":null,"topics":["bot","discord-bot","discord-js","javascript","nulldev","shop"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NullDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-30T02:42:33.000Z","updated_at":"2024-09-21T02:21:08.000Z","dependencies_parsed_at":"2023-05-28T09:15:30.246Z","dependency_job_id":"0f0ffd50-d1d6-4a96-ace5-306f4640bab4","html_url":"https://github.com/NullDev/Discord-RoleShop","commit_stats":null,"previous_names":["nulldev/discord-roleshop"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2FDiscord-RoleShop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2FDiscord-RoleShop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2FDiscord-RoleShop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2FDiscord-RoleShop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NullDev","download_url":"https://codeload.github.com/NullDev/Discord-RoleShop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245140856,"owners_count":20567457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","discord-bot","discord-js","javascript","nulldev","shop"],"created_at":"2024-10-14T01:07:35.566Z","updated_at":"2025-03-23T17:31:03.111Z","avatar_url":"https://github.com/NullDev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Discord-RoleShop\n[![cd](https://github.com/NullDev/Discord-RoleShop/actions/workflows/cd.yml/badge.svg)](https://github.com/NullDev/Discord-RoleShop/actions/workflows/cd.yml) [![License](https://img.shields.io/github/license/NullDev/Discord-RoleShop?label=License\u0026logo=Creative%20Commons)](https://github.com/NullDev/Discord-RoleShop/blob/master/LICENSE) [![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/NullDev/Discord-RoleShop?logo=Cachet)](https://github.com/NullDev/Discord-RoleShop/issues?q=is%3Aissue+is%3Aclosed)\n\n\u003cp align=\"center\"\u003e\u003cimg height=\"150\" width=\"auto\" src=\"https://cdn.discordapp.com/avatars/1102551839674740737/89848012463df027b4db688e05b89a44.png\" /\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cb\u003eDiscord Bot for a Roleshop with currency that can be earned by writing messages.\u003c/b\u003e\u003c/p\u003e\n\u003chr\u003e\n\n## :question: What does it do?\n\nUser earn points by writing messages. With those points, they can purchase special roles from a built-in shop.\n\n\u003chr\u003e\n\n## :satellite: Invite the bot\n\n[![Invite](https://img.shields.io/badge/Invite-37a779?style=for-the-badge)](https://discordapp.com/oauth2/authorize?client_id=1102551839674740737\u0026scope=bot\u0026permissions=1099780064256)\n\n\u003csub\u003eThe link above will invite a bot hosted by me that uses the latest version of this repo. \u003cbr\u003e\nAlternatively you can host the bot yourself. Instructions [below ⏬](#wrench-setup) \u003c/sub\u003e\n\n\u003chr\u003e\n\n## :star: Features\n\n- [x] Earn points by writing messages\n- [x] Spend points in a built-in shop\n- [x] Customizable shop\n- [x] Random gifts\n    - Can be disabled\n    - Cooldown can be set\n    - Chance can be set\n- [x] Optional multiplier for server boosters [Default: 2x]\n    - Can be set on every Discord server individually\n- [x] Slash commands\n    - [x] Admin commands\n    - [x] User commands\n    - [x] Translations\n- [x] Multi-language support (Can be set on every Discord server individually)\n    - English (Peer reviewed ✅)\n    - German (Peer reviewed ✅)\n- [x] Easy to set up (Check [below](#wrench-discord-bot-setup-for-server-admins))\n    - Invite bot\n    - Add roles to the shop (`/rs-add-role`)\n    - Remove roles from the shop (`/rs-remove-role`)\n    - Add role icons to the shop (`/rs-set-role-icon`)\n    - [OPTIONAL] Set server language (`/rs-set-language`) [Default: English]\n    - [OPTIONAL] Set or disable booster multiplier (`/rs-set-multiplier`) [Default: 2x]\n    - [OPTIONAL] Toggle the spam filter (`/rs-spam-filter`) [Default: Enabled]\n    - [OPTIONAL] Toggle and configure random gifts (`/rs-random-gift`) [Default: Enabled, Cooldown: 4hours, Chance: 5%]\n- [x] Easy to self-host\n    - No external database needed\n    - Easy configuration system\n    - Install instructions provided [below](#wrench-dev-setup)\n- [x] Admin-only commands\n- [x] Fail-safes to prevent point loss on error\n- [x] Automatic Syncing to keep up with DB and Discord states \n- [x] _Smart Spam Filtering™_ via Exponential Smoothing \u0026 Moving Average\n- [x] Transaction log\n- [x] Leaderboard\n- [x] Ban / Unban users from using the bot\n\n\u003chr\u003e\n\n## :diamond_shape_with_a_dot_inside: Feature requests \u0026 Issues\n\nFeature request or discovered a bug? Please [open an Issue](https://github.com/NullDev/Discord-RoleShop/issues/new/choose) here on GitHub.\n\n\u003chr\u003e\n\n## :wrench: Discord Bot Setup for server admins\n\n**Setup**:\n\n- [Invite](https://img.shields.io/badge/Invite-37a779?style=for-the-badge) the bot.\n- Add roles to the shop (`/rs-add-role`)\n    - ATTENTION: Make sure the bots role `roleshop` is above the roles you added to the shop! (Server Settings -\u003e Roles -\u003e Drag the bots role above the roles you added to the shop)\n- Remove roles from the shop (`/rs-remove-role`)\n\n**Admin Commands**:\n\n- Set a role icon which will be displayed in the shop (`/rs-set-role-icon`)\n- Set server language (`/rs-set-language`) [Default: English]\n- Set or disable booster multiplier (`/rs-set-multiplier`) [Default: 2x]\n- Toggle the spam filter (`/rs-spam-filter`) [Default: Enabled]\n- Toggle and configure random gifts (`/rs-random-gift`) [Default: Enabled, Cooldown: 4hours, Chance: 5%]\n- Reset ALL server stats (`/rs-reset-all`)\n- Set the points of a user (`/rs-set-points`)\n- View the current transaction log (`/rs-transaction-log`)\n- List all registered roles (`/rs-list-roles`)\n- Show admin help (`/rs-admin-help`)\n\n**User Commands**:\n\n- View the shop (`/rs-shop`)\n- View your or another users points (`/rs-stats`)\n- Show the top 10 users with most points (`/rs-top`)\n- Return a role you bought from the shop (`/rs-return`)\n- Show user help (`/rs-help`)\n- Shop bot info (`/rs-info`)\n\n\u003chr\u003e\n\n## :wrench: Dev Setup\n\n0. Open up your favourite terminal (and navigate somewhere you want to download the repository to). \u003cbr\u003e\u003cbr\u003e\n1. Make sure you have NodeJS installed (\u003e= v20.0.0). Test by entering \u003cbr\u003e\n$ `node -v` \u003cbr\u003e\nIf this returns a version number, NodeJS is installed. **If not**, get NodeJS \u003ca href=\"https://nodejs.org/en/download/package-manager/\"\u003ehere\u003c/a\u003e. \u003cbr\u003e\u003cbr\u003e\n2. Clone the repository and navigate to it. If you have Git installed, type \u003cbr\u003e\n$ `git clone https://github.com/NullDev/Discord-RoleShop.git \u0026\u0026 cd Discord-RoleShop` \u003cbr\u003e\nIf not, download it \u003ca href=\"https://github.com/NullDev/Discord-RoleShop/archive/master.zip\"\u003ehere\u003c/a\u003e and extract the ZIP file.\u003cbr\u003e\nThen navigate to the folder.\u003cbr\u003e\u003cbr\u003e\n3. Install all dependencies by typing \u003cbr\u003e\n$ `npm install`\u003cbr\u003e\u003cbr\u003e\n4. 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` \u003cbr\u003e\u003cbr\u003e\n5. Configure it in your favourite editor by editing `config/config.custom.js`. OR use `npm run generate-config`\u003cbr\u003e\u003cbr\u003e\n6. Start it in development mode by running \u003cbr\u003e\n$ `npm start` \u003cbr\u003e\nor start in production mode \u003cbr\u003e\n$ `npm run start:prod` \u003cbr\u003e\u003cbr\u003e\n\n\u003chr\u003e\n\n## :nut_and_bolt: Configuration\n\nOnce the config has been copied like described in [Step 4](#wrench-setup), it can be changed to your needs:\n\n```js\n{\n    discord: {\n        bot_token: \"\", // Auth Token of the Discord bot. Can be created here: https://discordapp.com/developers/ \n        bot_status: \"Usage: /rs-help\", // Bot activity ala \"Is playing...\"\n    },\n    bot_settings: {\n        slash_command_prefix: \"rs\", // Prefix for all slash commands. e.g. `/rs-foo`, `/rs-bar`.\n        spam_filter: {\n            alpha: 0.4, // The smoothing factor for the expavg spam filter (smaller = stricter)\n            window: 5, // The window for the moving average (last `n` messages) for calculation\n        },\n        emote_server_id: \"\", // Server for uploading role icons to be displayed in shop\n    },\n}\n```\n\n\u003chr\u003e\n\n## :octocat: Contributors\n\n\u003ca href=\"https://github.com/NullDev/Discord-RoleShop/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=NullDev/Discord-RoleShop\" /\u003e\n\u003c/a\u003e\n\n\u003csub\u003eMade with [contrib.rocks](https://contrib.rocks).\u003c/sub\u003e\n\n\u003chr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulldev%2Fdiscord-roleshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnulldev%2Fdiscord-roleshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulldev%2Fdiscord-roleshop/lists"}