Chaotic Leonis

A self hosted discord bot, written in NodeJS using discord.js, that forwards RSS channels to your discord server.
Explore the docs »

View Demo · 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. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: projnull, n_chaotic_leonis, mobilex1122, linkedin_username, mobilex1122.eu, null, Chaotic Leonis, A self hosted discord bot, written in NodeJS using discord.js, that forwards RSS channels to your discord server.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To self host the bot for your own server, follow the instructions below, or you can use docker to run it quickly with little configuration.

Note: The docker image is currently not avabiable, but support will be added in the future.

Prerequisites

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

• npm

  npm install npm@latest -g

Installation

1. Get a discord bot API Key at https://discord.com/developers
2. Get an API key at https://multiavatar.com/
3. Clone the repo

   git clone https://github.com/projnull/n_chaotic_leonis.git

4. Copy config.example.ts as config.ts and change it's values to match your tokens DO NOT ENABLE AUTO UPDATE OR INIT MESSAGE UNTIL A CHANNEL ID HAS BEEN SET!
5. Install NPM packages

   npm install

6. Run the bot

   npm run start

7. Set the target channel on discord

   /channelid
   

   Set the channel id in the config.ts file.

   export const channels = ["CHENNEL_ID_HERE"];

8. Enable auto update and restart the bot

(back to top)

Usage

Coming soon...

For more examples, please refer to the (non existent) Documentation

(back to top)

Roadmap

• Core Functionality
• Env file for tokens
• Docker image
• Configuration from server using commands
  • Toggleable feed channels from settings command
  • Feed channels configuration using settings command

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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mobilex1122 - @mobilex1122 - null@mobilex1122.eu

Project Link: https://github.com/projnull/n_chaotic_leonis

(back to top)

Acknowledgments

• Discord.js
• Shields.io
• ReadMe Template

(back to top)