Colour me!
Colour me! is a simple Discord bot that allows server admins to give users the ability to change the colour of their own assigned colour roles!
Colour me! runs entirely on the Cloudflare Workers serverless platform.
Invite
Click here to add the bot to your Discord server.
Usage
Server admin commands
/colour-role add <role>
: Add a role to the list of roles that are allowed to change their own colour!
/colour-role remove <role>
: Remove a role previously added to the list of allowed roles!
/colour-role list
: See the current list of roles!
All of these require the Manage Roles
permission. Make sure the role you're adding already has a colour before you add it!
User commands
/colour-me random
: Change your role colour to a random colour!!
/colour-me colour <hexcode>
: Change your role colour to a specific hex code!
/about
: That's this, you're reading it!
Planned features
In the near future it is planned to have functionality to allow admins and optionally users to create their own coloured roles automatically.
Links
- Privacy Policy: TBD
- Support: https://discord.gg/5eTcNpqPph
- Add the bot to your server: Click here
Made with
Template README follows, for development
/create with Cloudflare Workers
A slash-create template, using Cloudflare Workers.
Getting Started
Cloning the repo
You can either use degit to locally clone this repo without git, or create a new repo from this template and clone that.
npx degit Snazzah/slash-create-worker
After that, make sure to install dependencies using npm or yarn:
npm install
# yarn
Installing and setting up Wrangler
Make sure to sign up for a Cloudflare Workers account in a browser before continuing. Install wrangler with npm or yarn:
npm install -g @cloudflare/wrangler
# yarn global add @cloudflare/wrangler
Read more about installing wrangler.
Afterwards, run wrangler login
to login to your Cloudflare account with OAuth:
wrangler login
Copy wrangler.example.toml
into wrangler.toml
. Make sure to fill in your account ID in the config and update the name of the worker. You can find your account ID here towards the right side.
Filling in secrets
You can enter in environment secrets with wrangler secret put
, here are the keys that are required to run this:
wrangler secret put DISCORD_APP_ID
wrangler secret put DISCORD_PUBLIC_KEY
wrangler secret put DISCORD_BOT_TOKEN
For a development environment using wrangler, you can also include DEVELOPMENT_GUILD_ID
for commands to be updated in that guild live
wrangler secret put DISCORD_APP_ID -e development
wrangler secret put DISCORD_PUBLIC_KEY -e development
wrangler secret put DISCORD_BOT_TOKEN -e development
wrangler secret put DEVELOPMENT_GUILD_ID -e development
If an error occurs when trying to create a worker to put the secret in, create a worker manually in the dashboard and set the subdomain. It will be overwritten later.
Development
You can run npm run dev
to start a development environment and use something like ngrok to tunnel it to a URL. To sync commands, copy .env.example
to development.env
and fill in the variables, then run npm run sync:dev
.
Note: When you create a command, make sure to include it in the array of commands in
./src/commands/index.ts
.
Production
To sync to production, copy .env.example
to .env
and fill in the variables, then run npm run sync
. To publish code to a worker, run npm run deploy
.