Skip to content
fm01-botPublic

About

[WIP] The source code for fm01, an all-in-one Discord bot.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

478 Commits

Folders and files

Repository files navigation

fm01

Crowdin GitHub Release GitHub Stars Discord Top Language Commit Activity

fm01 is a Discord bot built to replace and improve upon its predecessor, FightMan01 bot. It's a versatile bot featuring moderation, utility, and fun commands.

Self-hosting

Setup Steps

  1. Clone the repository

    git clone https://github.com/fm01-bot/bot.git
    cd bot
  2. Create a .env file in the project root (follow the .env.example template)

  3. Create a config.yml file following the structure of config.yml.example

  4. Install PostgreSQL (if not running with docker), then:

    • Create a user named lumin with the password you defined above
    • Create a database named lumin, preferably owned by the lumin user
    • Apply database migrations:
      uv run alembic upgrade head
  5. Run the bot

    uv run main.py

    uv run will automatically set up the virtual environment for you and download required dependencies from pyproject.toml.

    If you want to run the bot in debug mode, change the debug value in config.yml to true.

Using Docker

We've provided a Dockerfile and a compose file in the Github repo. You can simply run docker compose up -d --build to start the bot in a Docker container. Make sure to follow until step 3, because the bot still needs the .env and config.yml files to function properly.

Versioning & Releasing

Version numbers follow MAJOR.MINOR.PATCH:

  • MAJOR → Breaking changes (e.g., full module overhauls)
    • Resets MINOR and PATCH to 0
  • MINOR → New features or updated command sets
    • Resets PATCH to 0
  • PATCH → Bugfixes, internal tweaks, or localization updates

⚠️ Version suffixes (e.g., -beta, -dev) will not be present in the live bot.

About

[WIP] The source code for fm01, an all-in-one Discord bot.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages