Skip to content

puckzxz/ReactRoles

Repository files navigation

ReactRoles Docker Build GitHub License

Quicky setup Discord reaction roles with this easy to use bot.

Running Locally

Ensure you have both Node and TypeScript installed

A config.ts file in the src directory is required.

Take a look at src/config.template.ts for the variables you need to supply.

Once you have your config ready, open a terminal and run npm install && npm start

Deploying

Deploy with Docker by running

docker run -d --name reactroles -e TOKEN=mytoken -e PREFIX=myprefix puckzxz/reactroles

To optionally mount the database to the local file system run

docker run -d --name reactroles -e TOKEN=mytoken -e PREFIX=myprefix -v /my/path:/app/data puckzxz/reactroles

Commands

  • add
    Adds a message to the database
    add <Message ID> <Emoji> <Role>
    It can take more than one emoji and role
    add <Message ID> <Emoji 1> <Role 1> <Emoji 2> <Role 2>

  • remove
    Removes a message from the database
    remove <Message ID>

  • edit
    Replaces the role to be given of an existing message with a new role
    edit <Message ID> <MyOldRole> <MyNewRole>

  • show
    Returns a message showing all the messages currently in the database
    show

Built with

License

See UNLICENSE for more details