Skip to content

Commit

Permalink
Add plugin readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
hunterwb committed Aug 18, 2018
1 parent fb9ba11 commit d00246e
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 12 deletions.
11 changes: 3 additions & 8 deletions README.MD
Expand Up @@ -3,13 +3,8 @@
[![Build Status](https://img.shields.io/circleci/project/github/RuneStar/client.svg)](https://circleci.com/gh/RuneStar/client)
[![Discord](https://img.shields.io/discord/384870460640329728.svg?logo=discord)](https://discord.gg/G2kxrnU)

## [Download](https://github.com/RuneStar/launcher/releases)
Requires [Java 8+](http://www.oracle.com/technetwork/java/javase/downloads/index.html)

## Running
[**Download**](https://github.com/RuneStar/launcher/releases)

Requirements:

* [Java JRE 8+](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* [Launcher](https://github.com/RuneStar/launcher/releases)

## [Plugins](https://github.com/RuneStar/client/tree/master/plugins/src/main/java/org/runestar/client/plugins)
[**Browse Plugins**](https://github.com/RuneStar/client/tree/master/plugins/src/main/java/org/runestar/client/plugins)
@@ -0,0 +1,7 @@
# Castle Wars

* Replaces the white stripe on barricades with blue or red depending on which team placed it

* Shows barricades as normal npcs on the minimap

* Includes remaining seconds on the in-game timer
12 changes: 12 additions & 0 deletions plugins/src/main/java/org/runestar/client/plugins/clock/README.md
@@ -0,0 +1,12 @@
# Clock

Replaces the text of the Report Abuse button with a clock

Styles:

| Name | Description |
| --- | --- |
| UTC | Current time using UTC |
| Local | Current time using the local time zone |
| Jagex | Current time using GMT/BST |
| Login | Time since login |
Expand Up @@ -2,12 +2,12 @@

Use over 2600 emojis in game

* [Shortcodes](https://github.com/RuneStar/client/blob/master/plugins/src/main/resources/org/runestar/client/plugins/emojis/names.csv) -
Use by enclosing in colons like ```:rage:```
[**Shortcodes**](https://github.com/RuneStar/client/blob/master/plugins/src/main/resources/org/runestar/client/plugins/emojis/names.csv) -
Use by enclosing in colons like `:rage:`

* [Images](https://github.com/RuneStar/client/blob/master/plugins/src/main/resources/org/runestar/client/plugins/emojis/sheet_twitter_16.png)
[**Images**](https://github.com/RuneStar/client/blob/master/plugins/src/main/resources/org/runestar/client/plugins/emojis/sheet_twitter_16.png)

## Sources
### Sources

* [twitter/twemoji](https://github.com/twitter/twemoji) - Graphics

Expand Down
@@ -0,0 +1,3 @@
# Fps

Displays the current FPS
@@ -0,0 +1,3 @@
# Hide Lower Floors

Disables drawing floors that are below the current floor
@@ -0,0 +1,9 @@
# Low Detail

* Disables certain ground decorations

* Disables certain textures

* Lowers threshold for disabling player idle animations in populated areas

May need to re-log or load a new area for some features to take effect
@@ -0,0 +1,3 @@
# Mark Destination

Outlines the tile of the current destination
@@ -0,0 +1,3 @@
# Window Always on Top

Make the game always show above all other windows
@@ -0,0 +1,3 @@
# Window Size

Change the dimensions of the game and disable resizing
@@ -0,0 +1,3 @@
# Window Transparency

Modify the opacity of the game, allowing a partial view of any applications beneath

0 comments on commit d00246e

Please sign in to comment.