Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Among Legends discord bot ๐Ÿคก๐Ÿ”ช
https://github.com/alexandrelam/among-legends

among-us discord-bot discord-js leagueoflegends

Last synced: 3 months ago
JSON representation

Among Legends discord bot ๐Ÿคก๐Ÿ”ช

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]





Logo

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



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgments

## About The Project

![amonglegend1](https://user-images.githubusercontent.com/25727549/137308783-49b73228-b92e-40db-a0ce-919f699b41d3.gif)

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

(back to top)

### Built With

- [DiscordJs](https://discordjs.guide/#before-you-begin)

(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
```sh
npm install npm@latest -g
```

### Installation

1. Clone the repo
```sh
git clone https://github.com/alexandrelam/among-legends
```
2. Install NPM packages
```sh
npm install
```
3. Set up bot on discord developer portal ([guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html))
4. Adding bot to server ([guide](https://discordjs.guide/preparations/adding-your-bot-to-servers.html))
5. Enter your API in `.env` file
```js
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](https://github.com/alexandrelam/among-legends/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 - [email protected]

Victor DELIEGE - [email protected]

Project Link: [https://github.com/alexandrelam/among-legends](https://github.com/alexandrelam/among-legends)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/alexandrelam/among-legends.svg?style=for-the-badge
[contributors-url]: https://github.com/alexandrelam/among-legends/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/alexandrelam/among-legends.svg?style=for-the-badge
[forks-url]: https://github.com/alexandrelam/among-legends/network/members
[stars-shield]: https://img.shields.io/github/stars/alexandrelam/among-legends.svg?style=for-the-badge
[stars-url]: https://github.com/alexandrelam/among-legends/stargazers
[issues-shield]: https://img.shields.io/github/issues/alexandrelam/among-legends.svg?style=for-the-badge
[issues-url]: https://github.com/alexandrelam/among-legends/issues
[license-shield]: https://img.shields.io/github/license/alexandrelam/among-legends.svg?style=for-the-badge
[license-url]: https://github.com/alexandrelam/among-legends/blob/main/LICENSE