https://github.com/runelite/runelite

Open source Old School RuneScape client
https://github.com/runelite/runelite

oldschool-runescape osrs runescape

Last synced: 6 days ago
JSON representation

Open source Old School RuneScape client

• Host: GitHub
• URL: https://github.com/runelite/runelite
• Owner: runelite
• License: bsd-2-clause
• Created: 2016-04-30T20:48:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T16:54:00.000Z (about 2 months ago)
• Last Synced: 2024-10-29T11:58:11.583Z (about 2 months ago)
• Topics: oldschool-runescape, osrs, runescape
• Language: Java
• Homepage: https://runelite.net
• Size: 74.3 MB
• Stars: 4,802
• Watchers: 97
• Forks: 5,235
• Open Issues: 2,096
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-game-remakes - RuneLite - Open source Old School RuneScape (OSRS) client. :flower_playing_cards: (Online)

README

        
![](https://runelite.net/img/logo.png)

# runelite [![CI](https://github.com/runelite/runelite/workflows/CI/badge.svg)](https://github.com/runelite/runelite/actions?query=workflow%3ACI+branch%3Amaster) [![Discord](https://img.shields.io/discord/301497432909414422.svg)](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://runelite.net/discord) 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).