Fix project structure

Haha kut had a point, tests are enabled in travis just for assurance.
This commit is contained in:
zeruth
2019-04-18 15:59:45 -04:00
parent 28aacb6aac
commit 335724441c
4 changed files with 28 additions and 35 deletions

View File

@@ -1,29 +1,17 @@
![](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)
![](https://i.imgur.com/sBLouZ7.png)
RuneLite is a free, open source OldSchool RuneScape client.
[![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/HN5gf3m) [![Travis](https://travis-ci.com/zeruth/runelit.svg?branch=master)](https://travis-ci.com/zeruth/runelit)
RuneLit is a fork of [RuneLite](https://github.com/runelite/runelite) that provides more functionality and less restrictions while staying open source. This is meant to directly compete with 3rd party RL clients that are trying to sell their code.
# Notable Features:
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](cache/src/main/java/net/runelite/cache) - Libraries used for reading/writing cache files, as well as the data in it
- [http-api](http-api/src/main/java/net/runelite/http/api) - API for api.runelite.net
- [http-service](http-service/src/main/java/net/runelite/http/service) - Service for api.runelite.net
- [runelite-api](runelite-api/src/main/java/net/runelite/api) - RuneLite API, interfaces for accessing the client
- [runelite-mixins](runelite-mixins/src/main/java/net/runelite) - Mixins which are injected into the injected client's classes
- [runescape-api](runescape-api/src/main/java/net/runelite) - Mappings correspond to these interfaces, runelite-api is a subset of this
- [runelite-client](runelite-client/src/main/java/net/runelite/client) - Game client with plugins
## Usage
Open the project in your IDE as a Maven project, build the root module and then run the RuneLite class in runelite-client.
For more information visit the [RuneLite Wiki](https://github.com/runelite/runelite/wiki).
### License
RuneLite is licensed under the BSD 2-clause license. See the license header in the respective file to be sure.
## Contribute and Develop
We've set up a separate document for our [contribution guidelines](https://github.com/runelite/runelite/blob/master/.github/CONTRIBUTING.md).
### Auto patch-time Bytecode patcher
What a mouthful right? it's great though.
The heart of the auto patching system is ByteCodePatcher. Adding a new patch would go as follows.
1. Find unique identifier for class so it can be found after rev update, Add check<rsClass> to ByteCodePatcher.
2. Create Transformer for rsClass and call it when class is identified.
A fully functional example is included at ActorTransform:
transformGetAnimation removes filtering
transformAnimationChanged removes filtering