MauricioX13/LOL-RUNES

Obtain runes from desired summoner during game

LOL - Runes

Get the runes a given summoner is using in an active game
Demo Report Bug

Table of Contents

1. About The Project
   • How it works
   • Built With
2. Getting Started
   • Pre requisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

StreamElements Command

How it works

The project was created with the aim of querying information through Riot Games' APIS and using this information in lives on Twitch, through commands from the StreamElements bot.

To create the command, simply use the syntax below in the Twitch live chat where you want to create the command. Remembering that the project must be hosted and use the hosting address followed by the route name.

  !cmd add runes $(customapi.https://mydomain.com/getRunesRoute)

Replacing mydomain.com with your real domain, just use !runes and the command will return with the summoner's data.

---

Built With

Technologies used in the project.

Libraries

• tsup Bundle your TypeScript library with no config, powered by esbuild.

Frameworks

• Fastify Fast and low overhead web framework, for Node.js.

Technologies

• TypeScript A strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.

APIS

• Riot Developer Portal

Endpoints: SUMMONER-V4 fetch the invoker ID provided in the SUMMONER_NAME environment variable and use it in the SPECTATOR endpoint

SPECTATOR-V4 to get runes in an active game from a given summoner

Pre requisites

1. Access the .env.example file and rename it to .env

2. Generate your api key in the following

  https://developer.riotgames.com/

Copy the value and paste it inside the quotes in RIOT API in the .env file

3. Do the same with the summoner's nickname, pasting it into SUMMONER_NAME

4. Get the region code from the summoner and paste it into REGION

Here is a list of the acronyms for the regions:

Region Code	Host
BR1	br1.api.riotgames.com
EUN1	eun1.api.riotgames.com
EUW1	euw1.api.riotgames.com
JP1	jp1.api.riotgames.com
KR	kr.api.riotgames.com
LA1	la1.api.riotgames.com
LA2	la2.api.riotgames.com
NA1	na1.api.riotgames.com
OC1	oc1.api.riotgames.com
TR1	tr1.api.riotgames.com
RU	ru.api.riotgames.com
PH2	ph2.api.riotgames.com
SG2	sg2.api.riotgames.com
TH2	th2.api.riotgames.com
TW2	tw2.api.riotgames.com
VN2	vn2.api.riotgames.com

Installation

1. Clone the repo

   git clone https://github.com/SilasRodrigues19/LOL-RUNES.git

2. Install dependencies (you can use npm, pnpm, yarn or anything else)

   pnpm install

3. In the project directory, you can run development mode with the following

   pnpm run dev

   or build and run production mode with the following

   pnpm run build && pnpm start

4. You can access the main route at the following address

     http://localhost:3333/getRunesRoute

Optionally, you can install the REST Client extension and run directly through VSCode using the routes.http file

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.

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

License

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

Contact

Silas Rodrigues - @jinuye1 - silasrodrigues.fatec@gmail.com

Project Link: https://github.com/SilasRodrigues19/LOL-RUNES

---

🔼 Back to top