Skip to content

DeJayDev/speedboat

Repository files navigation

Speedboat

Speedboat is a fork of rowboat: A Discord bot focused on being a highly powerful and configurable moderation and utilitarian bot for Discord. Speedboat is complete with user infractions, filtering, a web panel with advanced access and the ability to request custom analytics for your servers. Speedboat aims to eventually become a plug and play replacement for public moderation bots under such a load that speed and efficiency start to fall off. Speedboat's configuration is built to feel and behave similarly to AutoModerator for reddit.

Main Discord

widget

Should I Run Speedboat Locally?

I mean, if you want to. Speedboat has a lot of random moving pieces making spinning it up a bit more complicated.

However, if you manage to pull it off, we have a place for people like you.

DM me on Discord: DeJay#1337

Development

Speedboat development is focused on the requirements of the servers seeking Speedboat for core moderation. Generally a good overview of general planned or in-development tasks is the Trello Board, although its by no means a purely-true source.

Can I Contribute?

It depends. Feel free to submit PRs, and we'll talk in your pull request. Feel free to have your server administrator reach out to me with your suggestions.

(I am desperately seeking PRs focused around the frontend and web panel.)

How Do I Contribute?

To get a local version of Speedboat running, you will need docker-compose setup locally.

Once installed, you can simply run docker-compose up and in theory your dependencies should be setup.

You may have to rerun the command after your first setup because of the way Postgres tables are created.

Postgres is going to give you some trouble, but the error message probably helps enough.

To give yourself global administrator, run docker-compose exec web ./manage.py add-global-admin USER_ID_HERE.

Finally, you must make sure to copy the example configuration and properly replace the values within.

Can I Use Speedboat?

Again, it depends. If you are interested in using Speedboat in your server, please message me and provide an invite alongside some general information about the server. At this time, Speedboat is only being added to larger (1-2k+ average CCU) servers that have more complex moderation requirements as we scale up to support more bots/become "public" (Google Forms application for the bot)

However, I am happy to add Speedboat to larger servers within the Minecraft community no questions asked.