Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bartekprtc/rito

Simple, crossplatform C++20 library for League of Legends client and Riot API
https://github.com/bartekprtc/rito

cmake cpp cpp20 lcu lcu-api league-of-legends lib library rest-api riot riot-api riot-games-api

Last synced: 3 months ago
JSON representation

Simple, crossplatform C++20 library for League of Legends client and Riot API

Host: GitHub
URL: https://github.com/bartekprtc/rito
Owner: bartekprtc
License: mit
Archived: true
Created: 2023-10-10T19:55:02.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-11-11T19:39:21.000Z (12 months ago)
Last Synced: 2024-04-16T13:56:36.623Z (7 months ago)
Topics: cmake, cpp, cpp20, lcu, lcu-api, league-of-legends, lib, library, rest-api, riot, riot-api, riot-games-api
Language: C++
Homepage:
Size: 355 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-league - Rito - C++ set of utility classes for Riot API and LCU API connection. (Developer Tools)

README

# rito

![linux gcc build](https://github.com/bartekprtc/rito/actions/workflows/linux_gcc.yml/badge.svg)
![linux clang build](https://github.com/bartekprtc/rito/actions/workflows/linux_clang.yml/badge.svg)
![windows build](https://github.com/bartekprtc/rito/actions/workflows/windows_cl.yml/badge.svg)

## Overview

Rito is a simple, crossplatform (Windows and Linux) C++20 library interfacing with Riot services (i.e. Riot REST API and League of Legends client). It is currently in development - API changes might occur at some point. Rito uses [POCO](https://github.com/pocoproject/poco) library in the backend. It offers a few classes which handle communication with Riot REST API, as well as with LoL client (LCU). For League client, Rito supports both REST API and Websocket communication.

## Features

You want to:
- Use Riot REST API easily? Use `Riot_rest_handler` class
- Get League client (LCU) params (port & remoting auth token) easily? Use `Lcu_process_handler` class
- Use League client REST API? Use `Lcu_rest_handler` class
- Connect to League client using Websocket? Use `Lcu_websocket_handler` class
- Use LCU events (with WAMP protocol over Websocket)? Use `Lcu_wamp_handler` class

Details in [Docs](https://github.com/bartekprtc/rito/wiki/Docs) wiki page and in [Doxygen documentation](https://bartekprtc.github.io/rito/).

## Build

### Quickstart

#### Windows

You'll need `msvc` from `Visual Studio 2022` and `cmake`. Clone rito recursively:

``` powershell
> git clone --recursive [email protected]:bartekprtc/rito.git
```

Use embedded vcpkg to get all dependencies:

``` powershell
> .\tools\vcpkg\bootstrap-vcpkg.bat
> .\tools\vcpkg\vcpkg.exe install poco[netssl]
```

Configure, build and install the library:

``` powershell
> cmake -S . -B build "-DCMAKE_TOOLCHAIN_FILE=.\tools\vcpkg\scripts\buildsystems\vcpkg.make"
> cmake --build build --config Release
> cmake --build build -t install
```

#### Linux

You'll need `gcc` or `clang` 16, `cmake`, `ninja` and `poco` library. Install dependencies:

Ubuntu/Debian:

``` bash
$ sudo apt install gcc cmake ninja-build libpoco-dev
```

``` bash
$ sudo apt install clang cmake ninja-build libpoco-dev
```

Clone repo and build Rito:

``` bash
$ git clone [email protected]:bartekprtc/rito.git
$ cd rito
$ cmake -S . -B build
$ cmake --build build
```

Install library:

``` bash
$ sudo cmake --build build -t install
```

### Detailed build guide

Rito uses cmake as a build system. It can be built with gcc or clang-16 on Linux and with msvc on Windows. It depends on Poco library (with SSL). For details, see [Building Rito](https://github.com/bartekprtc/rito/wiki/Building-Rito) wiki page.

## Usage
Rito can be either installed on the system, or integrated within cmake project. See [Using Rito](https://github.com/bartekprtc/rito/wiki/Using-Rito) wiki page for more information on how to use the library and [Docs](https://github.com/bartekprtc/rito/wiki/Docs) wiki page for some brief overview of classes.

## Development/Contributing
Rito was meant to be a simple League stat collection application, which turned into a library. Even though it's very simple, I decided to make it into proper github project (with CI, coverage, tests and other fancy stuff) for learning purposes. I am happy to accept suggestions, reviews and pull requests. If you wish to contribute (or you're just interested in running tests/static analysis locally), see [Contributing](https://github.com/bartekprtc/rito/wiki/Contributing) wiki page.