Use channel pins as a managed starboard.
You will need to install poetry
to run this bot locally for development, but running in docker is preferred for production deployment.
Poetry can be installed using the following command:
- Windows:
py -3 -m pip install poetry
. - Linux/Mac:
python3 -m pip install poetry
.
To install the dependencies you can then run poetry install
in the folder you cloned the repository to.
You need to copy .env.example
to .env
and fill in the appropriate values.
To run the bot run poetry run task start
or docker-compose up
to run with docker.
To configure the starboard for a channel, navigate to the channel you wish to configure and enter the command
sp!setup
.
For more advanced config, you can use use the args sp!setup [channel] [emoji] [count]
to setup the channel
of the starboard, which emoji is used, and number of emojies required to be starred.
To remove the channel from being tracked by the starboard, use the command sp!remove
in the desired channel.
(You can optionally pass the channel to be removed as an argument).