alexandrelam / among-legends

Among Legends discord bot 🤡🔪

Among Legends

Best discord bot to play the new League custom game mode : Among Legends
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

This self-hosted bot allows you to play Among Legends with your friends on your discord server!

(back to top)

Built With

• DiscordJs

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You need the latest version of npm to run the server (>= node 16)

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/alexandrelam/among-legends

2. Install NPM packages

   npm install

3. Set up bot on discord developer portal (guide)
4. Adding bot to server (guide)
5. Enter your API in .env file

   CLIENT_ID=
   GUILD_ID=
   TOKEN=

6. Register all the commands with node deploy-commands.js
7. Launch the server using node .

(back to top)

Roadmap

• Better leaderboard
• Persistant database with Firebase
• Bug fixes

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

(back to top)

Contact

Alexandre LAM - [e-mail]

Victor DELIEGE - [e-mail]

Project Link: https://github.com/alexandrelam/among-legends

(back to top)