pupix / rift-explorer

🛠 Explore the API of the League of Legends client

Rift Explorer is no longer maintained. For an alternative, see 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.

Table of contents:

1. Getting Started
   • Requirements
   • Prebuilt Binaries
   • Building
     • Prerequisites
     • Run from source
     • Build from source
2. Bugs and Issues
3. Contributing
4. FAQ
5. 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

Run from source

1. Clone from repo

git clone https://github.com/Pupix/rift-explorer.git

2. Install dependencies

yarn install

3. Start League of Legends

4. Start Rift Explorer

yarn dev

Build from source

1. Clone from repo

git clone https://github.com/Pupix/rift-explorer.git

2. Install dependencies

yarn install

3. Build

yarn build

Bugs and Issues

For any bugs or issues please use the issue template

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
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

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 for more information.