Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Krystool/banhammer

 
 

Repository files navigation

Banhammer

The Banhammer project is an open source discord bot developed by HelloEdit, based on an original version of Loki for the French discord server of the international community that the SCP Foundation is.

This bot includes moderation, page search functions in the SCP Foundation database and other various commands.

It has been modified to fit the purposes of roleplay communities, and is set to function on one guild only.

Structure

src/
  - assets/     - ressource files like tags list...
  - commands/   - where the commands are located, sorted by group
  - helper/     - some small external functions for layout, verification etc...
  - middleware/ - functions performed before / after commands (authorization, error handler...)
  - plugin/     - Hershel's plugins executed at bot startup
  - types/      - Typescript type folder

Setting up

The bot expects several variables of specific environment:

  • DISCORD_TOKEN - Discord bot token
  • WIKIDOT_TOKEN - Wikidot API Token (read-only for security reasons)
  • NODE_ENV (optional) - dev or production (default to production)

Install

yarn i

Build Typescript files

yarn run build

FAQ

Why this FAQ?

To answer extremely interesting questions about bot design, architecture, political orientation and why not, about the various design choices.... Honestly, I just find the FAQs are way too swag.

Why rely on Hershel instead of Commando, Akairo or others?

Hershel was created to be as powerful as possible while remaining light and readable, two points that, I find, are too neglected by the other frameworks.

Hershel was created with the aim of combining comfort, simplicity and modularity.

I want that bot on my server. Now. Right now.

First of all, thank you very much for your interest in the project, you can't even imagine how happy I am. You can of course use the code under MIT license anywhere you want. You will need to host your own instance of the Banhammer, which is designed to run on only one Guild at a time.

Pain au chocolat or Chocolatine?

Butter croissant is better. dab

This FAQ is far too long

You weren't supposed to read until then.

License

MIT

☀️

About

✋ Bot for the French branch of the SCP Foundation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.1%
  • Dockerfile 0.9%