icybear/fabric-carpet
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
gnembon committed 2019-12-11 23:59:59 -04:00
1 parent 6abd3c33f2
commit 8c83641199
1 file changed
+74 -53
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+74 -53
View File
@@ -12,6 +12,7 @@ with other compatible mods.
Prevents players from rubberbanding when moving too fast
... or being kicked out for 'flying'
Puts more trust in clients positioning
Increases player allowed mining distance to 32 blocks
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
@@ -34,72 +35,78 @@ XP orbs combine with other into bigger orbs
## commandCameramode
Enables /c and /s commands to quickly switch between camera and survival modes
/c and /s commands are available to all players regardless of their permission levels
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandDistance
Enables /distance command to measure in game distance between points
Also enables brown carpet placement action if 'carpets' rule is turned on as well
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandDraw
Enables /draw commands
... allows for drawing simple shapes
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandInfo
Enables /info command for blocks
Also enables gray carpet placement action
if 'carpets' rule is turned on as well
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandLog
Enables /log command to monitor events in the game via chat and overlays
* Type: `boolean`
Enables /log command to monitor events via chat and overlays
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* A few bits still needs implementing - we are working on it
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandPerimeterInfo
Enables /perimeterinfo command
... that scans the area around the block for potential spawnable spots
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandPlayer
Enables /player command to control/spawn players
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandScript
Enables /script command
@@ -113,30 +120,33 @@ An in-game scripting API for Scarpet programming language
## commandSpawn
Enables /spawn command for spawn tracking
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandTick
Enables /tick command to control game clocks
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## commandTrackAI
Allows to track mobs AI via /track command
* Type: `boolean`
* Type: `String`
* Default value: `true`
* Required options: `true`, `false`
* Suggested options: `true`, `false`
* Categories: `COMMAND`
* Additional notes:
* It has an accompanying command
* Can be limited to 'ops' only, or a custom permission level
## ctrlQCraftingFix
Dropping entire stacks works also from on the crafting UI result slot
@@ -180,6 +190,14 @@ Explosions won't destroy blocks
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `CREATIVE`, `TNT`
## extremeBehaviours
Edge cases are as frequent as common cases, for testing only!!
Dispensers and Droppers will use extreme random velocity values
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `CREATIVE`
## fastRedstoneDust
@@ -222,6 +240,16 @@ Applies to pistons, observers, droppers, repeaters, stairs, glazed terracotta et
* Required options: `true`, `false`
* Categories: `CREATIVE`, `SURVIVAL`, `FEATURE`
## hardcodeTNTangle
Sets the horizontal random angle on TNT for debugging of TNT contraptions
Set to -1 for default behavior
* Type: `double`
* Default value: `0.0`
* Suggested options: `-1`
* Categories: `TNT`
* Additional notes:
* Must be between 0 and 2pi, or -1
## hopperCounters
hoppers pointing to wool will count items passing through them
Enables /counter command, and actions while placing red and green carpets on wool blocks
@@ -236,14 +264,6 @@ Items counted are destroyed, count up to one stack per tick per hopper
* Additional notes:
* It has an accompanying command
## horseWanderingFix
Prevents horses and other mobs to wander into the distance after dismounting
Fixes issues with various Joergens wandering off and disappearing client-side
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `BUGFIX`
## huskSpawningInTemples
Only husks spawn in desert temples
* Type: `boolean`
@@ -251,15 +271,6 @@ Only husks spawn in desert temples
* Required options: `true`, `false`
* Categories: `FEATURE`
## kelpGenerationGrowthLimit
limits growth limit of newly naturally generated kelp to this amount of blocks
* Type: `int`
* Default value: `25`
* Suggested options: `0`, `2`, `25`
* Categories: `FEATURE`
* Additional notes:
* You must choose a value from 0 to 25. 25 and all natural kelp can grow 25 blocks, choose 0 to make all generated kelp not to grow
## lagFreeSpawning
Spawning requires much less CPU and Memory
* Type: `boolean`
@@ -284,13 +295,12 @@ Customizable maximal entity collision limits, 0 for no limits
* Additional notes:
* Must be a positive number
## miningGhostBlockFix
Fixes mining ghost blocks by trusting clients with block breaking
Increases player allowed mining distance to 32 blocks
## mergeTNT
Merges stationary primed TNT entities
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `SURVIVAL`
* Categories: `TNT`
## missingTools
Pistons, Glass and Sponge can be broken faster with their appropriate tools
@@ -313,6 +323,13 @@ One player is required on the server to cause night to pass
* Required options: `true`, `false`
* Categories: `SURVIVAL`
## optimizedTNT
TNT causes less lag when exploding in the same spot and in liquids
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `TNT`
## persistentParrots
Parrots don't get of your shoulders until you receive proper damage
* Type: `boolean`
@@ -327,13 +344,6 @@ fixes block placement rotation issue when player rotates quickly while placing b
* Required options: `true`, `false`
* Categories: `BUGFIX`
## portalCaching
Alternative, persistent caching strategy for nether portals
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `SURVIVAL`, `CREATIVE`
## portalCreativeDelay
Portals won't let a creative player go through instantly
Holding obsidian in either hand won't let you through at all
@@ -395,7 +405,7 @@ Rotates block anti-clockwise if possible
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `FEATURE`
* Categories: `FEATURE`, `DISPENSER`
## scriptsAutoload
Scarpet script from world files will autoload on server/world start
@@ -454,14 +464,25 @@ TNT doesn't update when placed against a power source
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `CREATIVE`
* Categories: `CREATIVE`, `TNT`
## tntPrimerMomentumRemoved
Removes random TNT momentum when primed
* Type: `boolean`
* Default value: `false`
* Required options: `true`, `false`
* Categories: `CREATIVE`
* Categories: `CREATIVE`, `TNT`
## tntRandomRange
Sets the tnt random explosion range to a fixed value
Set to -1 for default behavior
* Type: `double`
* Default value: `-1.0`
* Suggested options: `-1`
* Categories: `TNT`
* Additional notes:
* optimizedTNT must be enabled
* Cannot be negative, except for -1
## unloadedEntityFix
Entities pushed or moved into unloaded chunks no longer disappear