From 8eba6be7c6a9d660567ad991c6baf2b46f37ec15 Mon Sep 17 00:00:00 2001 From: Kyleeld <48519776+Kyleeld@users.noreply.github.com> Date: Mon, 6 May 2019 01:10:11 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8aca86afd1..e3c91e6097 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ ![](https://i.imgur.com/OVRdQBz.png) -[![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/HN5gf3m) [![Build Status](https://travis-ci.org/runelite-extended/runelite.svg?branch=master)](https://travis-ci.org/runelite-extended/runelite) + + +# RuneLitePlus [![Build Status](https://travis-ci.org/runelite-extended/runelite.svg?branch=master)](https://travis-ci.org/runelite-extended/runelite) [![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/HN5gf3m) + [RuneLitePlus](https://runelitepl.us) 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. + +## 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 + +### License + +RuneLitePlus 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-extended/runelite/blob/master/.github/CONTRIBUTING.md). From 9838246e43ee7abb297e6d8346ad30d5e2aa8c75 Mon Sep 17 00:00:00 2001 From: Kyleeld <48519776+Kyleeld@users.noreply.github.com> Date: Mon, 6 May 2019 01:11:29 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e3c91e6097..7ff563d196 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ - [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 -### License +## License RuneLitePlus is licensed under the BSD 2-clause license. See the license header in the respective file to be sure. From 6722be51d545c448e5b8c7aeb73bf45e88164828 Mon Sep 17 00:00:00 2001 From: Kyleeld <48519776+Kyleeld@users.noreply.github.com> Date: Mon, 6 May 2019 01:12:23 +0100 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5d463d8bcf..fe0d820eca 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,7 +14,7 @@ Here are the guidelines we'd like you to follow: ## Got a Question or Problem? -If you have questions about how to contribute to runelite, please join our [Discord](https://discord.gg/mePCs8U) server. +If you have questions about how to contribute to runelite, please join our [Discord](https://discord.gg/HN5gf3m) server. ## Found an Issue? @@ -43,7 +43,7 @@ quickly: ### Submitting a Pull Request Before you submit your pull request consider the following guidelines: -* Search [GitHub](https://github.com/runelite/runelite/pulls) for an open or closed Pull Request +* Search [GitHub](https://github.com/runelite-extended/runelite/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. * [Fork](https://help.github.com/articles/fork-a-repo/) this repo. * [Clone](https://help.github.com/articles/cloning-a-repository/) your copy. @@ -54,7 +54,7 @@ Before you submit your pull request consider the following guidelines: * After cloning, set a new remote [upstream](https://help.github.com/articles/configuring-a-remote-for-a-fork/) (this helps to keep your fork up to date) ```shell - git remote add upstream https://github.com/runelite/runelite.git + git remote add upstream https://github.com/runelite-extended/runelite.git ``` * Make your changes in a new git branch: @@ -130,5 +130,5 @@ from the main (upstream) repository: To ensure consistency throughout the source code, review our [code conventions](https://github.com/runelite/runelite/wiki/Code-Conventions). -[github]: https://github.com/runelite/runelite -[discord]: https://discord.gg/mePCs8U +[github]: https://github.com/runelite-extended/runelite +[discord]: https://discord.gg/HN5gf3m