diff --git a/README.md b/README.md index 602ed8f..ef82bca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -#PlayerRider +# PlayerRider -PlayerRider is a very simple plugin for Spigot *(Minecraft server)* which allows you to ride other players. You can also make towers by riding a player who already rides another, and organize funny run because the rider can whip the player to give him a temporary boost. +PlayerRider is a very simple plugin for [Spigot](https://www.spigotmc.org) *(Minecraft server)* which allows you to ride other players. You can also make towers by riding a player who already rides another, and organize funny run because the rider can whip the player to give him a temporary boost. -##How to use it? +## How to use it? Right click on a player to ride him. Press the sneak key to get off. @@ -24,19 +24,19 @@ You can whip him by right clicking on his head while holding one the allowed ite If you have the permission `playerrider.ride`, you can eject your rider by raise up your head and right click on him. -##Requirements +## Requirements -You need a Spigot / PaperSpigot, version 1.13 **(only tested in 1.13.2)**. There is no plugin dependencies. +You need a [Spigot](https://www.spigotmc.org) / [PaperSpigot](https://papermc.io), version 1.13 **(only tested with 1.13.2)**. There is no plugin dependencies. -##Installation +## Installation -Simply copy **PlayerRider.jar** into your "plugins" directory, then start the server. A new folder containing the default `config.yml` is automatically generated. +Simply copy [PlayerRider.jar](https://github.com/arboriginal/PlayerRider/releases) into your "plugins" directory, then start the server. A new folder containing the default `config.yml` is automatically generated. -##Commands +## Commands * **prider-reload**: Reload the configuration. -##Permissions +## Permissions * **playerrider.reload**: Allows to use `/prider-reload` command. * **playerrider.ride**: Allows to ride a player. @@ -44,16 +44,16 @@ Simply copy **PlayerRider.jar** into your "plugins" directory, then start the se * **playerrider.duck**: Allows to be ridden. * **playerrider.eject**: Allows to eject your passenger. -##Configuration +## Configuration -Edit `plugins/PlayerRider/config.yml` then reload the plugin, or the server if you prefer (it also works well with [plugman](https://dev.bukkit.org/projects/plugman)). All parameters are explained in the config.yml from the source code. +Edit `plugins/PlayerRider/config.yml` then reload the plugin, or the server if you prefer (it also works well with [plugman](https://dev.bukkit.org/projects/plugman)). All parameters are explained in the [config.yml from the source code](https://github.com/arboriginal/PlayerRider/blob/master/src/config.yml). -##Previous version +## Previous version I did this plugin in 2012, as an easter egg, players on the server I was got tons of fun with it *(we mainly used it on new guys who are not correct)*. So I've decided to extract this part, and shared it as an independent plugin on [Bukkit.org page](http://dev.bukkit.org/projects/playerrider). Then, I've stopped to play at Minecraft, and seen people grabbed the code and make their own "updated" versions *(with minor modifications like change the value of the API...)* without mention the origin, this had discouraged me to make new releases. -##For now +## For now I've recently started a server with friends, so it gives me motivation to re-use Java and develop new plugins. I've ported this one because it was funny to play with and quick to upgrade. The new version contains (much) more options and a few funny features. -##TODO +## TODO Because hitboxes have changed, the player ridden can see his rider's legs. I will work soon to improve this not to reduce the FOV. But the plugin is fully working except this visual effect.