Rx3/Factions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved reamefile again

Browse Source
This commit is contained in:
Olof Larsson 2011-02-06 15:09:13 +01:00
parent 47275aa472
commit 7c1e176320
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -11,41 +11,43 @@ With this plugin...
Usage Usage
--------- ---------
The chat console command is: The chat console command is:
`/f`
* `/f`
This command has subcommands like: This command has subcommands like:
`/f create My faction name`
`/f invite my friends name`
`/f claim`
`/f map`
... etc
Read the full guide here: * `/f create My faction name`
* `/f invite my friends name`
* `/f claim`
* `/f map`
* ... etc
http://mcteam.org/factions Read the full userguide here: [http://mcteam.org/factions](http://mcteam.org/factions)
You may also read the documentation ingame as the plugin ships with an ingame help manual. Read the help pages like this: You may also read the documentation ingame as the plugin ships with an ingame help manual. Read the help pages like this:
`/f help 1`
`/f help 2` * `/f help 1`
`/f help 1` * `/f help 2`
* `/f help 1`
Note that you may optionally skip the slash and just write Note that you may optionally skip the slash and just write
`f`
* `f`
Installing Installing
--------- ---------
1. Download the latest release: https://github.com/oloflarsson/Factions/raw/master/releases/latest.zip 1. Download the latest release: [latest.zip](https://github.com/oloflarsson/Factions/raw/master/releases/latest.zip)
1. Put the included gson.jar here `/your_server_folder/gson.jar` 1. Put the included gson.jar here `/your_server_folder/gson.jar`
1. Put the included Factions.jar here `/your_server_folder/plugins/Factions.jar` 1. Put the included Factions.jar here `/your_server_folder/plugins/Factions.jar`
Compiling Compiling
--------- ---------
<b>You will need the Bukkit library to compile (Bukkit.jar)</b> <b>You will need the Bukkit library to compile (Bukkit.jar)</b><br/>
You can download it here: http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/ You can download it here: [http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/](http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/)
<b>You will also need Google GSON in your build path.</b> <b>You will also need Google GSON in your build path.</b><br/>
You can download it here: http://code.google.com/p/google-gson/ You can download it here: [http://code.google.com/p/google-gson/](http://code.google.com/p/google-gson/)<br/>
<b>OR</b> you can use the gson.jar in the folder `/packaging` <b>OR</b> you can use the file in this repo `/packaging/gson.jar`<br/>
However you won't get javadocs and source that way. However you won't get javadocs and source that way.
You will need to include the MANIFEST.MF and plugin.yml in your jar. All bukkit plugins need a plugin.yml and the MANIFEST.MF is needed for the plugin to find the gson.jar (wich should be in the same folder as the main server jar when running the server). You will need to include the MANIFEST.MF and plugin.yml in your jar. All bukkit plugins need a plugin.yml and the MANIFEST.MF is needed for the plugin to find the gson.jar (wich should be in the same folder as the main server jar when running the server).