Update README

This commit is contained in:
PseudoKnight 2018-08-27 05:33:49 -07:00
parent f07aac9907
commit 5a7342ebf3

22
README
View File

@ -124,10 +124,10 @@ Custom Gate Layout
You can create as many gate formats as you want, the gate layouts are stored in plugins/Stargate/gates/
The .gate file must be laid out a specific way, the first lines will be config information, and after a blank line you will lay out the gate format. Here is the default nether.gate file:
portal-open=90
portal-closed=0
X=49
-=49
portal-open=NETHER_PORTAL
portal-closed=AIR
X=OBSIDIAN
-=OBSIDIAN
XX
X..X
@ -139,9 +139,6 @@ portal-open/closed are used to define the material in the gate when it is open o
"X" and "-" are used to define block "types" for the layout (Any single-character can be used, such as "#").
In the gate format, you can see we use "X" to show where obsidian must be, "-" where the controls (Button/sign) are.
You will also notice a "*" in the gate layout, this is the "exit point" of the gate, the block at which the player will teleport in front of.
As of version 0.5.5 you can supply block data in the format
X=35:15
Which would only allow black wool. If no data is supplied any version of a block will work (Any color of wool for example)
==============
Configuration
@ -165,6 +162,7 @@ handleVehicles - Whether or not to handle vehicles going through gates. Set to f
sortLists - If true, network lists will be sorted alphabetically.
protectEntrance - If true, will protect from users breaking gate entrance blocks (This is more resource intensive than the usual check, and should only be enabled for servers that use solid open/close blocks)
signColor: This allows you to specify the color of the gate signs. Valid colors:
verifyPortals: Whether or not all the non-sign blocks are checked to match the gate layout when a stargate is loaded.
debug - Whether to show massive debug output
permdebug - Whether to show massive permission debug output
@ -207,15 +205,15 @@ createConflict=Gate conflicts with existing gate
=============
Known Bugs
=============
Unable to reproduce: Stargates teleport a user into the ground/under the ground
Bukkit Issue: Stargate will randomly NPE when drawing a sign. Long-standing Bukkit
issue, that they just made worse by disallowing me to override the
sign class. This won't actually affect Stargate use.
Stargates are stored under player names, not UUIDs. This will be changed in the future.
=============
Changes
=============
[Version 0.7.9.11]
[Version 0.8.0.0] PseudoKnight fork
- Update for 1.13 compatibility. This changes gate layouts to use new material names instead of numeric ids. You need to update your gate layout configs.
- Adds "verifyPortals" config option, which sets whether a stargate layout is verified when it is loaded.
[Version 0.7.9.11] PseudoKnight fork
- Removed iConomy support. Updated Vault support. Changed setting from "useiconomy" to "useeconomy".
- Updated to support Metrics for 1.7.10
[Version 0.7.9.10]