README.md

TagBot

A tagbot for Discord.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• cargo

  cargo run

• rethinkdb

  	docker run --name some-rethink -v "$PWD:/data" -d rethinkdb

Installation

1. Create an application at https://discord.com/developers

2. Clone the repo

   git clone https://github.com/Sven65/TagBot.git

3. Enter your bot token and RethinkDB credentials in .env

   BOT_TOKEN=my_bot_token
   
   RETHINK_HOST=rethink_host
   ...

(back to top)

Usage

This bot has some commands that can be used in discord, the most prominent being /tag. For more, check the commands directory.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Legacy tag support
• Lua scripting
  • Serenity userdata
    • interaction guild_id
    • interaction channel_id
    • interaction member
    • interaction user
  • Serenity userdata functions
  • Automatic luadoc generation

See the open issues for a full list of proposed features (and known issues).

(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 with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m '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 OSL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/Sven65/TagBot

(back to top)

Acknowledgments

• Best Readme Template

(back to top)

Generating docs: Set env var "GENERATE_DOCS" to "true"