055f5c2d2b
These are being split into a separate repository at https://github.com/runelite/api.runelite.net
26 lines
1.4 KiB
Markdown
26 lines
1.4 KiB
Markdown
|
|
# runelite [](https://github.com/runelite/runelite/actions?query=workflow%3ACI+branch%3Amaster) [](https://discord.gg/ArdAhnN)
|
|
|
|
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/ArdAhnN) 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
|
|
- [runelite-api](runelite-api/src/main/java/net/runelite/api) - RuneLite API, interfaces for accessing the client
|
|
- [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).
|