Skip to content

Commit 43811b1

Browse files
authored
Update README with info about XML file, fixes #36
1 parent 3270474 commit 43811b1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
LiveSplit.MemoryGraph
22
=====================
3-
Shows a value of a game's memory in a graph. Probably buggy as hell atm.
3+
Shows a value of a game's memory in a graph.
44

55
![preview.png](/images/preview.png)
66

@@ -10,9 +10,12 @@ Download "Components/LiveSplit.MemoryGraph.dll" and place it into the subdirecto
1010

1111
Usage
1212
-----
13-
You need to tell the plugin, where in the memory it can find the value that you want to display. You can find some known memory addresses in the [Wiki](https://github.com/kugelrund/LiveSplit.MemoryGraph/wiki) or by downloading an XML file inside of the component.
13+
You need to tell the plugin, where in the game's memory it can find the value that you want to display.
14+
For many games, some kind people have already looked for values worth displaying and added them to our [XML file](https://github.com/kugelrund/LiveSplit.MemoryGraph/blob/master/XML/LiveSplit.MemoryGraph.Games.xml).
15+
The settings of the component can be used to download that XML file, which then allows to select a game and one of its known values via the dropdown menu.
1416

15-
If the address for the value that you want to display is not there, you can find it out yourself using for example the free program Cheat Engine.
17+
If the address for the value that you want to display is not there yes, you can try to find it by yourself using for example the free program Cheat Engine.
18+
The process is very similar to that when writing your own [AutoSplitter](https://github.com/LiveSplit/LiveSplit.AutoSplitters/blob/master/README.md) for LiveSplit, so it might be worth to check out some of that documentation. If you were successful in finding your value, consider adding it to our [XML file](https://github.com/kugelrund/LiveSplit.MemoryGraph/blob/master/XML/LiveSplit.MemoryGraph.Games.xml) via a pull request, so that other people can use it in the future.
1619

1720
Credits
1821
-----

0 commit comments

Comments
 (0)