Skip to content

Commit a3df70c

Browse files
authored
Create README.md
1 parent 770034f commit a3df70c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<h1 align="center">
2+
JSONSubscribe
3+
</h1>
4+
5+
<h4 align="center">Subscribes to all JSON API events from the LCU.
6+
7+
8+
![screenshot](https://raw.githubusercontent.com/H-Bains/JSONSubscribe/master/JSONSubscribe/JSONSubscribe.gif)
9+
10+
## Description
11+
12+
The League of Legends client creates an internal webserver upon being launched.
13+
By obtaining the credentials from the generated lockfile, a connection can be established to the WAMP server to monitor JSON API results.
14+
This can be used to explore the LCU API and gain a deeper understanding of how the client operates.
15+
16+
## Key Features
17+
18+
* JSON Deserialization
19+
- Deserializes JSON data received from the WAMP OnJsonApiEvent.
20+
21+
* Beautify results
22+
- Encloses the uri, event type, and data in a block for readability.
23+
24+
* Auto Connect
25+
- Automatically connects to a running LCU instance.
26+
27+
## How To Use
28+
29+
To use this application, make sure you are on a Windows machine with administrator privileges.
30+
Launch the League of Legends client, then launch JSONSubscribe.
31+
JSONSubscribe will automatically attach to the running LCU instance.
32+
33+
## Credits
34+
35+
This software uses the following open source packages:
36+
37+
- [WebSocketSharp](https://github.com/sta/websocket-sharp)
38+
- [Fody Costura](https://github.com/Fody/Costura)
39+
- [Json.net](https://github.com/JamesNK/Newtonsoft.Json/)
40+
- [SimpleJson](https://github.com/simplejson/simplejson)
41+
42+
## License
43+
44+
MIT
45+
46+
---

0 commit comments

Comments
 (0)