Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pupix/rift-explorer
🛠Explore the API of the League of Legends client
https://github.com/Pupix/rift-explorer
Last synced: 3 months ago
JSON representation
🛠Explore the API of the League of Legends client
- Host: GitHub
- URL: https://github.com/Pupix/rift-explorer
- Owner: Pupix
- License: mit
- Created: 2016-06-22T21:14:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T05:40:03.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T23:30:43.316Z (6 months ago)
- Language: CSS
- Homepage:
- Size: 5.4 MB
- Stars: 552
- Watchers: 25
- Forks: 74
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-league - RiftExplorer - Electron application to explore the LCU API. (Developer Tools)
- awesome-esports - Rift Explorer - An automatically generated documentation of Riot Games LCU API. (Unofficial documentation / Tournaments management)
README
### Rift Explorer is no longer maintained. For an alternative, see [LCU Explorer](https://github.com/HextechDocs/lcu-explorer).
---
----
# Always up to date documentation for the League Client API.
Rift Explorer helps aid development of LCU applications by generating documentation of the LCU
API.
## What is the LCU?
For more information as to what the LCU is please refer to [this link](https://developer.riotgames.com/docs/lol#league-client-api).
## Table of contents:
1. [Getting Started](#getting-started)
- [Requirements](#requirements)
- [Prebuilt Binaries](#prebuilt)
- [Building](#building)
- [Prerequisites](#prerequisites)
- [Run from source](#run-from-source)
- [Build from source](#build-from-source)
1. [Bugs and Issues](#bugs-and-issues)
1. [Contributing](#contributing)
1. [FAQ](#faq)
1. [License](#license)
## Getting Started
## Requirements
- Windows 7 or above (64-bit)
- macOS sierra or above (64-bit)
- Linux is partially supported(64-bit). - if you would like to help please open an issue regarding it
*Note: 32-bit is unsupported.*
## Prebuilt
The latest prebuilt binaries for Windows and macOS can be found below
Â
## Building
### Prerequisites
- [Yarn 1.x.x](https://classic.yarnpkg.com/lang/en/)
### Run from source
#### 1. Clone from repo
```SHELL
git clone https://github.com/Pupix/rift-explorer.git
```
#### 2. Install dependencies
```SHELL
yarn install
```
#### 3. Start League of Legends
#### 4. Start Rift Explorer
```shell
yarn dev
```
### Build from source
#### 1. Clone from repo
```SHELL
git clone https://github.com/Pupix/rift-explorer.git
```
#### 2. Install dependencies
```SHELL
yarn install
```
#### 3. Build
```shell
yarn build
```
## Bugs and Issues
For any bugs or issues please use the [issue template](.github/ISSUE_TEMPLATE/bug_report.md)
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
1. Commit your Changes (git commit -m 'Add some AmazingFeature')
1. Push to the Branch (git push origin feature/AmazingFeature)
1. Open a Pull Request
## FAQ
**Q: Why is a 32-bit version of Rift Explorer missing?**
A: We have never supported 32-bit versions of Rift Explorer and will never provide support nor downloads for 32-bit versions,
However it can be built from source but as said previously no support will be given if an issue arises.
Any issues relating to 32-bit versions of Rift Explorer will simply be closed.
## License
Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for more information.