ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Adam
2017-02-13 09:50:34 -05:00
committed by GitHub
parent f695e1f759
commit 7e873d02eb
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -2,12 +2,17 @@
runelite is a RuneScape 2 client and reverse engineering project runelite is a RuneScape 2 client and reverse engineering project
## project layout Our IRC channel is on [irc.rizon.net #runelite](http://qchat.rizon.net/?channels=runelite&uio=d4)
## Project Layout
- cache - libraries used for reading/writing cache files, as well as the data in it - cache - libraries used for reading/writing cache files, as well as the data in it
- deobfuscator - contains bytecode deobfuscator, mapper for handling updates, and the injector - deobfuscator - contains bytecode deobfuscator, mapper for handling updates, and the injector
- http-api - API for api.runelite.net
- http-service - Service for api.runelite.net
- model-viewer - RS Model, NPC/Object, and terrain viewer
- runelite-api - runelite api, use this for plugin development - runelite-api - runelite api, use this for plugin development
- runescape-api - mappings correspond to these interfaces. runelite-api wraps this. - runescape-api - mappings correspond to these interfaces, runelite-api wraps this
- runescape-client-injector - builds the injection from the vanilla client and the mappings - runescape-client-injector - builds the injection from the vanilla client and the mappings
- runescape-client - decompiled RuneScape client, contains mappings - runescape-client - decompiled RuneScape client, contains mappings
@@ -18,4 +23,4 @@ Open the project in your IDE as a Maven project and run the RuneLite class in ru
### License ### License
Most of Runelite is licensed under the BSD 2-clause license. See the license header in the respective file to be sure. Most of Runelite is licensed under the BSD 2-clause license. See the license header in the respective file to be sure.
Some of the code, like evreything in runescape-client, is automatically generated, and is not licensed. Some of the code, like everything in runescape-client, is automatically generated, and is not licensed.