Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ImOlli/go-lcu
A small library to automatically retrieve port and auth-token of the league of legends client
https://github.com/ImOlli/go-lcu
api lcu league leagueoflegends
Last synced: 3 months ago
JSON representation
A small library to automatically retrieve port and auth-token of the league of legends client
- Host: GitHub
- URL: https://github.com/ImOlli/go-lcu
- Owner: ImOlli
- License: mit
- Created: 2023-05-27T10:25:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-27T21:45:45.000Z (about 1 year ago)
- Last Synced: 2024-04-16T13:56:37.380Z (7 months ago)
- Topics: api, lcu, league, leagueoflegends
- Language: Go
- Homepage:
- Size: 13.7 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-league - go-lcu - Go Library to automatically retrieve the port and token of the LCU and wrap it behind a reverse proxy. (Developer Tools)
README
# GO-LCU
[](https://pkg.go.dev/github.com/ImOlli/go-lcu)
This library automatically retrieves the port and auth-token for the LCU(League of Legends Client)
[What's the LCU?](https://riot-api-libraries.readthedocs.io/en/latest/lcu.html)
> **Important!** This library currently only works on windows.
## Install
```shell
go get github.com/ImOlli/go-lcu
```
## Usage
### Get port and auth-token of LeagueClient
```go
package main
import (
"github.com/ImOlli/go-lcu/lcu"
"log"
)
func main() {
info, err := lcu.FindLCUConnectInfo()
if err != nil {
if lcu.IsProcessNotFoundError(err) {
log.Println("No LeagueClient process found!")
return
}
panic(err)
}
log.Printf("LeagueClient is running on port %s and you can authenticate with following token: %s", info.Port, info.AuthToken)
}
```
### Create Proxy
If you don't want to use SSL and import the self-signed certificate of the league client you can use the proxy method to
create a reverse proxy. The proxy also automatically adds the authentication header, so you don't have to add it yourself.
This proxy runs then under http and the specified hostname.
```go
package main
import (
"github.com/ImOlli/go-lcu/proxy"
"log"
)
func main() {
// Automatically resolves the port and auth token of the lcu and creates a reverese proxy
p, err := proxy.CreateProxy(":8080")
if err != nil {
panic(err)
}
// Optionally you can disable cors or the certificate check
p.DisableCORS = true
p.DisableCertCheck = true
log.Fatal(p.ListenAndServe())
}
```