Skip to content

Commit

Permalink
* add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Johannes-Schneider committed Nov 3, 2020
1 parent 99524f6 commit 67c4507
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# GoldDiff

_GoldDiff_ is a neat little tool that uses Riot Game's official [Client API](https://developer.riotgames.com/docs/lol#league-client-api) to display and compare the combined item costs of every player - much like the well known LCS gold comparison.

<br>

![GoldDiffPreview](__img/GoldDiffPreview.png)

<br>

# How it works

During your games, your League Client publishes various live stats of what is happening ingame. <br>
In general, these are pretty much the exact same data as you can see in your ingame scoreboard - kills, deaths, items etc. <br>
_GoldDiff_ reads these data periodically and displays them in a user friendly way that allows you to gain a quick overview of your game's current state. <br>

## __Important__

_GoldDiff_ __does not__ use any other data besides those that Riot Games officially allows! <br>
Especially, there is
* __no__ memory inspection
* __no__ network traffic reading
* __no__ process manipulation

Thus, _GoldDiff_ __does not__ give you any unfair advantage over your opponent and, therefore, is perfectly safe for you to use - _GoldDiff_ __is not__ a Hack!
Binary file added __img/GoldDiffPreview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 67c4507

Please sign in to comment.