aoi-yuito / wakalaka-rs

No-nonsense general-purpose Discord bot written with love in Rust.

Waka Lichtstern, drawn by kedoi#4581

Wakalaka

A work-in-progress, self-hostable Discord bot written purely in Rust, inspired by Red and Dyno.

As of now, Wakalaka is in Beta. She's not ready for full-time use, but she's ready for testing and feedback. If you feel like testing her, click here to bring her to your server.

Keep in mind that my programming skills are far from decent and that I don't consider myself a developer or a programmer. Any issue you have, please report it here instead of keeping it to yourself. I'm always looking for ways to improve my projects, and to ensure I fulfill the requests of other people for the sake of pleasing them. Thanks.

---

Community

If you have any questions or ideas, or if you want to share your thoughts about the project, you're welcome to join our Discord server or start a chat on GitHub Discussions.

I'm always open to feedback and interested in hearing what you think about my projects. Your input can help make Wakalaka even better!

---

Contributing

All Rust users are invited to contribute to this project. You can suggest improvements, report issues, or submit changes directly.

If you find this project useful, or meaningful, feel free to give it a ⭐. This helps me understand how popular the project is and encourages me to continue improving it.

While there's no set way to contribute to this project, please do follow the Rust Code of Conduct. As I'm more familiar with Java, my Rust code may not be perfect. I welcome any corrections or suggestions.

---

Reporting Issues or Suggesting Features

If you spot any issues or have any ideas, feel free to open an issue. I'll aim to sort out the problem or add the feature as quickly as I can.

To open an issue, follow these steps:

1. Click the Issues tab at the top of the project page.
2. Click the New issue button at the top right of the project page.
3. Choose the type of issue you want to open.
4. Fill in the required details and click the Submit new issue button.

---

Forking and Making Pull Requests

As a fellow Rust user, I'm always open to new ideas and improvements. If you have any, feel free to make a copy of the project and submit a pull request. I'll look at it as soon as I can.

To make a copy of the project and submit a pull request, follow these steps:

1. Make a copy of the project by clicking the Fork button at the top right of the project page.
2. Download the copied project to your computer using Git or GitHub Desktop.
   • Or, you can click the Download ZIP button after clicking the Code button at the top right of the project page to download the project as a zip file.
3. Make changes to the project.
4. Commit the changes to your copied project.
5. Submit a pull request by clicking the Pull request button at the top right of the project page.

---

Building from Source

Prerequisites

Before you start, make sure you've got Rust on your computer. You can check if you've got Rust by typing rustc --version in your terminal.

If you haven't got Rust, you can get it by following the steps on the Rust website.

Compilation

To compile the project, follow these steps:

1. Download the project to your computer.
2. Go to the project directory.
3. Type sqlx database create to create a new database .db file.
   • If you can't run sqlx, you can install it by typing cargo install sqlx-cli --no-default-features --features sqlite.
4. Run sqlx migrate run to create the database tables if they don't exist, which they don't if you've just created the database.
5. Type cargo build --release to build the project for general use. Or, type cargo build to build the project for use in development.

The executable will be in the target directory.

---

Licence

This project is licenced under the MIT License. You can use the project for any purpose, but you must include the original copyright and licence.