Villager-Bot icon indicating copy to clipboard operation
Villager-Bot copied to clipboard

The code behind Villager Bot, a multipurpose Minecraft-themed Discord bot

Villager Bot

CodeFactor Bot Status Server Count Support Server CI

Notable Features

  • Ability to generate Minecraft pixel art from images sent in the chat
  • Ability to ping / check the status of any Minecraft server
  • Expansive economy system (based upon emeralds obviously!)
  • Multi-language support! (English, Español, Français, Português)
  • Tons of customization and configuration options

Support / Contact Information

Privacy Policy

Technologies

Contributing

Issues / Bugs

If a bug or unintended behavior is discovered, please report it by creating an issue here or by reporting it in the #bug-smasher channel on the support server.

Development

If you'd like to contribute code to Villager Bot, then please fork the repository and make any necessary changes there. Then, make a pull request and it will be reviewed. Please read the contribution guidelines before making changes.

Setting up Villager Bot

  1. git clone Villager Bot, and cd into the Villager-Bot directory.
  2. create a PostgreSQL database, and execute the contents of setup.sql to create the necessary tables.
  3. make a new file called secrets.json and fill in the fields based off the secrets.example.json file for both bot/ and karen/
  4. use poetry to install the required dependencies with poetry install.

Running Villager Bot

  1. Make sure the specified cluster count in karen/secrets.json is 1
  2. Run Karen with poetry run py -m karen (or poetry run python3 ... if not on windows)
  3. Run a bot cluster with poetry run py -m bot (or poetry run python3 ... if not on windows)
  • Running with Docker is also possible, but requires a .env file based off the .env.example to be created. Then to build run docker compose build and to run docker compose up