Skip to content

Commit

Permalink
Update pom and README to reflect changes to project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam- committed May 16, 2018
1 parent 06aa5cd commit 75674cf
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 11 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
![](https://runelite.net/img/logo.png)
# runelite [![Travis](https://img.shields.io/travis/runelite/runelite.svg)](https://travis-ci.org/runelite/runelite) [![Discord](https://img.shields.io/discord/301497432909414422.svg)](https://discord.gg/mePCs8U)

runelite is a RuneScape 2 client and reverse engineering project
RuneLite is a free, open source OldSchool RuneScape client.

If you have any questions, please join our IRC channel on [irc.rizon.net #runelite](http://qchat.rizon.net/?channels=runelite&uio=d4) or alternatively our [Discord](https://discord.gg/mePCs8U) server.

## Project Layout

- 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
- 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, interfaces for accessing the client
- runelite-mixins - Mixins which are injected into the injected client's classes
- runescape-api - Mappings correspond to these interfaces, runelite-api is a subset of this
- runelite-client - Game client with plugins
- runescape-client-injector - Builds the injected client from the vanilla client and the mappings
- runescape-client - Decompiled RuneScape client, contains mappings

## Usage

Expand All @@ -26,8 +23,7 @@ For more information visit the [RuneLite Wiki](https://github.com/runelite/runel

### License

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 everything in runescape-client, is automatically generated and is not licensed.
RuneLite is licensed under the BSD 2-clause license. See the license header in the respective file to be sure.

## Contribute and Develop

Expand Down
6 changes: 1 addition & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<packaging>pom</packaging>

<name>RuneLite</name>
<description>Open source RuneScape client and deobfuscator</description>
<description>Open source RuneScape client</description>
<url>http://runelite.net</url>

<properties>
Expand Down Expand Up @@ -115,17 +115,13 @@
<module>cache-client</module>
<module>cache-server</module>
<module>cache-updater</module>
<module>deobfuscator</module>
<module>model-viewer</module>
<module>runelite-api</module>
<module>runelite-client</module>
<module>runelite-mixins</module>
<module>runelite-script-assembler-plugin</module>
<module>runelite-scripts</module>
<module>runescape-api</module>
<module>runescape-client</module>
<module>runescape-client-injector</module>
<module>runescape-client-injector-plugin</module>
<module>http-api</module>
<module>http-service</module>
<module>protocol-api</module>
Expand Down

0 comments on commit 75674cf

Please sign in to comment.