README
¶
LoL Replay
LoL Replay is a collection of Go packages to record and play back League of Legends games from the spectator endpoint. It is designed to be fast, reliable, and efficient. The modular design allows anyone to write their own recording service in Go and manipulate the recording files.
The packages are:
- record: Retrieves data from the League of Legends servers and stores it into a recording.
- recording: Encodes and decodes recordings to a file (or any io.ReadWriteSeeker) using a custom binary format which is able to serve data quickly with a small memory footprint.
- replay: Serves recordings over HTTP to be played back using the League of Legends client.
- server: Contains the runnable HTTP server which has a web interface, automates recordings, and plays back recordings.
Documentation
If you would like package documentation, check the GoDoc.
Server Setup
LoL Replay currently assumes your client is running OS X and has LoL Spectator installed to copy and paste replay links into. This should hopefully change to support Windows and OS X without additional programs soon.
go get -u github.com/harmonherring/lol-replay/pkgserver- A binary called
serverwill be installed to your$GOPATH/bin - Download the sample configuration.
- Configure to your liking. Note that platform IDs are taken from here.
- Server binary usage:
./server [configuration file location]. If no configuration file location is specified, it will default toconfig.json. - The web host will be running at the bind address specified in the configuration file. Try playing a game, and navigating your browser to it.
If you need help, have an issue or want to ask a question, feel free to contact me by email or by making an issue on GitHub.
Using Docker
The LoL Replay server is also available as an image on Docker. Refer to the Docker Hub page for more information.
Screenshots
License
lol-replay is licensed under the MIT license which can be found here.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
record
Package record is an interface to record League of Legends games to a file using data from the spectator endpoint.
|
Package record is an interface to record League of Legends games to a file using data from the spectator endpoint. |
|
recording
Package recording handles the encoding and decoding of recorded games to files.
|
Package recording handles the encoding and decoding of recorded games to files. |
|
replay
Package replay handles the serving of recorded data through a HTTP router.
|
Package replay handles the serving of recorded data through a HTTP router. |