Factions/README.md

73 lines
2.5 KiB
Markdown
Raw Normal View History

2018-12-19 20:07:08 +01:00
<center>
<a href="http://www.spigotmc.org/resources/factionsuuid.1035/"><img src="https://i.imgur.com/3PCF7tz.png"></a>
</center>
2017-12-19 09:40:17 +01:00
2018-02-06 04:57:28 +01:00
[![Discord](https://imgur.com/MFRRBn4.png)](https://discord.gg/FfAz3eE)
2017-12-19 09:40:17 +01:00
2014-09-03 15:46:47 +02:00
<rant>
2018-02-11 02:39:36 +01:00
I'd appreciate it if you could pay for the (http://www.spigotmc.org/resources/factionsuuid.1035/) if your server makes money. If you only run your server for your kids or some friends and don't make any money, then I don't want to stop you from doing so by forcing you to buy a $15 plugin. If that's the case, then just send me a message and we can work something out.
2014-09-03 15:46:47 +02:00
The repo is open because of that and because I still hope to see people contributing upstream :)
</rant>
2011-02-06 14:52:49 +01:00
This plugin will allow the players on the server to create factions/guilds. The factions can claim territory that will be protected from non-members. Factions can forge alliances and declare themselves enemies with others. Land may be taken from other factions through war.
The goals of this plugin:
2011-02-06 15:00:47 +01:00
* The players should be able to take care of anti-griefing themselves.
* Inspire politics and intrigues on your server.
* Guilding and team spirit! :)
2014-08-26 20:09:05 +02:00
* Auto convert old 1.6.9.x versions to save with UUIDs.
2011-02-06 14:52:49 +01:00
2016-05-31 05:08:47 +02:00
Versioning
----------
All versions prefixed with `1.6.9.5` as that is the legacy version.
Followed by -U noting that it's the FactionsUUID fork.
FactionsUUID versioning: `U<major>.<minor>.<patch>-<tag>`
* Major version: Incompatible API changes
* Minor version: Add backwards compatible features
* Patch: Fixing bugs
* SNAPSHOT: Version is in bug fixing stage
* Release Candidate (RC): Potentially a release
2011-02-06 14:52:49 +01:00
Usage
---------
<b>Read the full userguide here: [Factions Wiki](https://github.com/drtshock/Factions/wiki)</b>
2011-02-06 14:52:49 +01:00
The chat console command is:
2011-02-06 15:09:13 +01:00
* `/f`
2011-02-06 14:52:49 +01:00
This command has subcommands like:
* `/f create MyFactionName`
* `/f invite MyFriendsName`
2011-02-06 15:09:13 +01:00
* `/f claim`
* `/f map`
* ... etc
2011-02-06 15:00:47 +01:00
2011-02-06 14:52:49 +01:00
You may also read the documentation ingame as the plugin ships with an ingame help manual. Read the help pages like this:
2011-02-06 15:09:13 +01:00
* `/f help 1`
* `/f help 2`
* `/f help 3`
2011-02-06 14:52:49 +01:00
Note that you may optionally skip the slash and just write
2011-02-06 15:09:13 +01:00
* `f`
2011-02-06 14:52:49 +01:00
Installing
----------
2016-05-31 05:08:47 +02:00
1. Download the latest release [on Spigot](https://www.spigotmc.org/resources/factionsuuid.1035/)<br>
1. Put Factions.jar in the plugins folder.
2011-02-06 13:36:11 +01:00
A default config file will be created on the first run.
2011-02-06 14:52:49 +01:00
License
----------
2011-03-05 11:39:14 +01:00
This project has a LGPL license just like the Bukkit project.<br>
This project uses [GSON](http://code.google.com/p/google-gson/) which has a [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0 ).
2011-02-06 14:52:49 +01:00