Library of Wan Shi Tong

An open source Discord bot for the Avatar Minecraft mod server.
Join us on Discord »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Why make our own bot?
   • Built with
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

The Library of Wan Shi Tong is a Discord bot for the Avatar Minecraft mod server. It is a work in progress and is currently in the alpha stage of development. The bot is written in Kotlin using the JDA library. The purpose of the bot is to provide a variety of useful features for the server, such as an easy ticket system, and more features yet to be decided.

(back to top)

Why make our own bot?

While there are a variety of bots that provide the same features as the Library of Wan Shi Tong, we decided to make our own bot for a few reasons:

• Customization: We wanted to be able to customize the bot to our needs, and not be limited by the features of other bots.
• Learning: We wanted to learn how to use Kotlin, and this seemed like a good opportunity to do so.
• Fun: We wanted to make a bot that we could use on our own server, and that we could share with others.
• Open Source: We wanted to make the bot open source since that is one of our core values, so that others can contribute to it, and learn from it.
• Community: We wanted to make a bot that would be useful for our community, and that would help us grow as a community.

(back to top)

Built with

(back to top)

Getting started

This guide is not yet finalised and may not be complete. It is also not yet tested.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Java 18

  • To check if you have Java installed, run the following command:

    java -version

    It should return a version number, such as 18.0.1. Ensure that the version number is 18 or higher.

Installation

1. Clone the repo

   git clone https://github.com/amuzil/lwst.git

2. Run the bot to generate the config file

   ./gradlew run

3. Add your bot token to the config file

   1. Follow the JDA getting started guide up to step 1 of "Connecting to Discord with a Bot Account".
   2. Open the config.json file
      • On Linux, it will be located in XDG_CONFIG_HOME/LWST/configuration.yml
        • If XDG_CONFIG_HOME is not set, it will be located in ~/.config/LWST/configuration.yml
      • On Windows, it will be located in %APPDATA%\LWST\configuration.yml
      • On macOS, it will be located in ~/Library/Application Support/LWST/configuration.yml
      • On other operating systems, it will be located in ~/.config/LWST/configuration.yml
   3. Replace the value of the token key with your bot token
   4. Save the file

4. Run the bot

   ./gradlew run

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. If you really like the project, consider giving it a star!

Something we like to use it Gitmoji, which is an emoji guide for Git commit messages. It makes it easier to see what kind of changes have been made at a glance. While not required, we heavily recommend using it.

To make things easier, check out Gitmoji Plus: Commit Button, a plugin for JetBrains IDEs that adds a button to the commit dialog that allows you to easily add a Gitmoji to your commit message.

While the below guide details specific git commands, you also can (and probably should) use a GUI for Git. Options include any JetBrains IDE (such as IntelliJ IDEA), GitHub Desktop, or GitKraken.

1. Fork the Project

2. Create your Feature Branch

   git checkout -b feature/AmazingFeature

3. Commit your Changes

   git commit -m ":sparkles: Add some AmazingFeature"

4. Push to the Branch

   git push origin feature/AmazingFeature

5. Open a Pull Request

(back to top)

License

Distributed under the Unlicense. See license.md for more information.

(back to top)

Contact

Main contact: Luka "Mahtaran" Leer

(back to top)

Acknowledgments

• Readme template by Othneil Drew

(back to top)