No description
Find a file
2024-05-04 18:28:19 +01:00
.idea Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
migrations Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
src Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
.gitignore Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
Cargo.lock Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
Cargo.toml Add some sqlite tables and stuff 2024-05-04 18:28:19 +01:00
README.md Add README.md 2024-04-29 10:57:32 +01:00

Potato Assistant

Potato Assistant is a Discord bot written in Rust, using the serenity-rs and poise libraries. It provides various functionalities to enhance your Discord server experience, including integration with Minecraft servers running on Docker.

Prerequisites

  • Rust programming language
  • Cargo package manager
  • Docker

Installation

  1. Clone the repository:
git clone https://forge.dwnet.uk/wizardfrag/potato_assistant.git
  1. Navigate to the project directory:
cd Potato-Assistant
  1. Build the project:
cargo build --release

Configuration

Potato Assistant requires the DISCORD_TOKEN environment variable to be set. This is the token of the Discord bot that you want to run the code on.

You can set the environment variable in your shell like so:

export DISCORD_TOKEN=your_discord_token_here

Or you can use a .env file in the root of the project with the following content:

DISCORD_TOKEN=your_discord_token_here

Running

After setting the DISCORD_TOKEN environment variable, you can run the bot with:

cargo run

Minecraft Integration

Potato Assistant can integrate with Minecraft servers running on Docker. It uses the PlayerDB API to fetch player data, and provides commands to look up a player's UUID, username, and avatar, set a Minecraft username, and check a Minecraft UUID.

Future features will allow controlling the Minecraft server from Discord. It depends on the Minecraft server being run in a Docker container using itzg/minecraft-server.

Ensure the Docker daemon is accessible from the host running Potato Assistant.

Features

Potato Assistant provides various commands and features to enhance your Discord server experience. For more details, please refer to the source code.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.