Kawaxte / wakalaka-rs

A straightforward, modular and extensible Discord application.

Waka Lichtstern, drawn by kedoi#4581

Wakalaka

A work-in-progress, self-hostable Discord bot written in Rust for the general public. She aims to contain enough features to be useful to a small range of users.

In case you haven't tried her out and want to, click here to invite her to your server.

---

Community

If you have any questions or ideas, or if you want to share your thoughts, 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.

---

Contributing

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 Rust Code of Conduct.

---

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

If you have any improvements or fixes to be applied, feel free to make a copy of the project and submit a pull request. I'll look at it as soon as I can.

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.

In the meantime, if you're new to Rust, check out this simplified guide. I recommend this over the official Rust Book as it's easier to understand and doesn't use programmer jargon that most English speakers, native or not, may not understand.

Compilation

Begin by typing cargo build --release to create an optimised executable, or cargo build to create an unoptimised executable with debug symbols.

After that, the --release version will be in target/release directory while latter will be in target/debug directory.

Execution

To use yours truly, follow these steps:

1. Go to target/releases or target/debug directory. This depends on if you made a release or debug version.
   1. If you're on Linux, you need to make it executable by typing chmod +x ./wakalaka.
2. Run by typing ./wakalaka on Linux. On Windows, type wakalaka.exe in Command Prompt or ./wakalaka.exe in PowerShell.

---

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.