Mousey

Moderation tools for your Discord Servers.

Go to file

LostLuma a3eff9c68d Split messages into smaller chunks to acount for other handling later on		2023-11-23 19:37:46 +01:00
packages	Split messages into smaller chunks to acount for other handling later on	2023-11-23 19:37:46 +01:00
.gitignore	[frontend] Add test app to test auto deploy	2021-01-19 17:10:33 +01:00
.prettierrc	Move JS tools to root directory	2021-02-06 21:34:14 +01:00
LICENSE	Initial commit	2021-01-15 06:09:57 +01:00
README.rst	Remove to do list from readme	2021-06-16 19:47:47 +02:00
package-lock.json	Bump dependency versions	2022-08-11 11:28:14 +02:00
package.json	Replace all mentions of old username with LostLuma	2021-04-07 16:06:36 +02:00
pyproject.toml	Initial commit	2021-01-15 06:09:57 +01:00
requirements.txt	Bump dependency versions	2022-08-11 11:28:14 +02:00

README.rst

======
Mousey
======

Mousey is a WIP moderation and utility bot for Discord.

You may `invite the official instance <https://mousey.app/invite>`_ to your server, or self-host the bot.

Development
-----------

The bot uses custom events in addition to the ones provided by Discord, you can identify these
by the ``mouse_`` prefix and find where they are defined by searching the project for the name.

If you'd like to contribute changes please test them locally first, you can do so pretty easily using Docker:

- Create an ``.env`` file with your configuration in the relevant package directory
- To run the API run ``docker-compose -f docker-compose.yaml -f docker-compose-dev.yaml up`` in ``packages/api``
- Running the bot also requires starting the the API, then you can run ``docker-compose up`` in ``packages/bot``