Rankaisijabot

Really good bot
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Rankaisijabot is a good bot

Built With

• Python

Getting Started

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

Prerequisites

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

• python 3
• pip

Installation

1. Clone the repo

   git clone https://github.com/villheik/Rankaisijabot.git

2. Install pip packages

   pip install -r requirements.txt

3. Set your bot token to env variable BOT_TOKEN

     $env:BOT_TOKEN = ' bot token '
     or
     export BOT_TOKEN = bot_token
   

4. Run bot

   python -m bot
   

Usage

Default chat command prefix is '!', e.g. !info

Roadmap

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

Contributing

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

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

New features are added in the cogs folder. The cogs that are loaded for the bot to use are configured in config.yml

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/villheik/Rankaisijabot

Acknowledgements

• Rankaisijat