Skip to content

Latest commit

 

History

History
executable file
·
404 lines (253 loc) · 11.9 KB

README-en.md

File metadata and controls

executable file
·
404 lines (253 loc) · 11.9 KB
Raw

Opt Carpet Addition Mod

Language: English | 中文

This is an extension mod of Carpet. The goal is to add some functions that do not greatly change the original game mechanism but optimize the player experience.

WARNING: Don't download mods with the -source suffix, it is just for development!!!

Build with Preprocessor

Dependencies:Carpet fabric-api

Support Status

Most other MC versions that are the same as the supported major versions but have different minor versions can be directly installed and work properly, but the stability cannot be guaranteed. Please use them with caution

Minecraft Version Support Status
1.20.4 Supporting, developing actively
1.20.1 Supporting, developing actively
1.19.3 Supporting, developing actively
1.18.2 Supporting, developing actively
1.17.1 Supporting, developing actively
1.16.5 Not supporting, development stopped (supporting stopped on Jan 8, 2023)

Rules

commandTpToFakePlayer

Enable '/player xxx tp' command to teleport to that fake player.

  • Default value: false
  • Acceptable value: true false ops
  • Categories: Command

commandTpHereFakePlayer

Enable '/player xxx tphere' command to teleport that fake player to me.

  • Default value: false
  • Acceptable value: true false ops
  • Categories: Command

allowTpToRealPlayer

Enable '/player xxx tp' command to teleport to that real player.

  • Default value: false
  • Acceptable value: true false ops
  • Categories: Command

allowTpHereRealPlayer

Enable '/player xxx tphere' command to teleport that real player to me.

  • Default value: false
  • Acceptable value: true false ops
  • Categories: Command

playerTpRateLimitTime

Rate limit of player xxx tp command.

Default value: 2 (unit: seconds) (permit 1 request per 2 seconds per player, no limit if value = 0)

  • Default value: 2
  • Acceptable value: numbers >= 0
  • Categories: Feature

fixXpLevelBug

Fix bug: xp level return to zero when player change dimension

  • Default value: false
  • Acceptable value: true false
  • Categories: FixBug

forceFakePlayerGameMode

Force gamemode for every fake player.

You can't force gamemode to 'spectator'

  • Default value: false
  • Acceptable value: survival creative adventure
  • Categories: Feature

enableTpPrefixBlacklist

@Water_Bucket provided this great idea!

Enable fake player Tp prefix blacklist
After this function is enabled, if the fake player name prefix you want to tp to is in the blacklist, it will prevent you from tp to him and display:You can't tp to this player because of tp limit.
For example: You want to tp to fake player: anti_mob,but 'anti' is in blacklist,so you can't tp to it
Fake player prefix blacklist can modify by command:/tpmanager

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

enableTpPrefixWhitelist

Enable fake player tp prefix whitelist

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

enableTpHerePrefixBlacklist

Enable fake player Tphere prefix blacklist

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

enableTpHerePrefixWhitelist

Enable fake player Tp prefix whitelist

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

disabledEnderManPickupGoal

Enderman will not pick up any block

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

disabledEnderManPlaceBlockGoal

Enderman will not place any block

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

disabledLayEggs

Chicken will not lay eggs

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

disabledEntityTick

Warning! This rule may cause all falling_block entity infinite rebound!

This rule will ignore all entity tick,but players are normal.

When there are a lot of entity in your server,you can use this rule temporarily relieve the stuck.

This rule is experimental.

  • Default value: false
  • Acceptable value: true false
  • Categories: Experimental

disabledNetherPortalSpawn

Zombified piglin will not spawn in nether portal.

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

disabledEntityTick

Warning! This rule may cause all falling_block entity infinite rebound!

This rule will ignore all entity tick,but players are normal.

When there are a lot of entity in your server,you can use this rule temporarily relieve the stuck.

This rule is experimental.

  • Default value: false
  • Acceptable value: true false
  • Categories: Experimental

disabledUpdateSuppressionErrorStackTrace

This rule is just in 1.17 and 1.18

This function must be used together with the carpet rule updateSuppressionCrashFix, otherwise it is invalid

This rule allows all non-fatal exceptions caused by update suppression not to be refreshed, and only one log is output: Update Suppression
1.16 and 1.19 hasn't this rule，because carpet-1.16&1.19 has not updateSuppressionCrashFix rule.
Fatal Exception will be printed normally（Fatal Exceptions mean the exception that will cause the server to crash when updateSuppressionCrashFix is not enabled）

  • Default value: false
  • Acceptable value: true false
  • Categories: BugFix

unescapeChatMessage

This rule is valid only on the client side, and invalid on the server side

This rule will escape all text sent by the client that should be escaped.

For example,type 你好，\u4e2d\u6587 in chat
And you will see 你好，中文 in chat.

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature CLIENT

optimizePlayerConnect

This rule is just in 1.17 and 1.18

Optimize player login.

  • Default value: false
  • Acceptable value: true false
  • Categories: Optimization Experimential

optimizeTeleport

This rule is just in 1.17 and 1.18

Optimize player teleport.

  • Default value: false
  • Acceptable value: true false
  • Categories: Optimization Experimential

commandLogger

Command Logger can records command execute events.

CommandLogger.json is the config file, type: /commandlogger reload to reload the config file.

  • Default value: false
  • Acceptable value: true false
  • Categories: Command Feature

commandLoggerBroadcastToPlayer

Which players should commands in commandLogger be broadcast to?

  • Default value: false
  • Acceptable value: true false ops
  • Categories: Command

dropperCrashFix

Fix bug: dropper may cause server crash

The discoverer of this bug is player kygo_life, who once posted an explanation on bilibili. However, it was deleted.

The triggering process of this bug is roughly as follows: First, build a structure similar to an item shadowing, but replace the box with a shulker box (which can be empty). At this time, open the trapdoor, destroy the shulker box, and the update suppression will be triggered.

Then place a dropper at the position of the shulker box, and then trigger it with a redstone signal (such as a lever), and boom!

This bug has been tested and available in 1.17.1, but has not been tested in other versions.

General principle:

  • After the shadow box is broken, the update suppression is triggered, so although the shadow box blocks are broken, the shulker box block entity are still exist.

  • The dropper block is placed, the block is a dropper, but the block entity remains a shulker box.

  • When triggered, the DropperBlock.dispense (...) method of that dropper will be called, and that method has the following code: (This line of code is exactly the same in yarn 1.17.1, 1.18.2, 1.19.3, 1.20.1)

DispenserBlockEntity dispenserBlockEntity = (DispenserBlockEntity)blockPointerImpl.getBlockEntity();
                                                  ^^^^^^^^^^
                                                class cast here!      shulker block entity -> dispenser block entity

  • So throwing ClassCastException during this can cause server crash（

  • Default value: false

  • Acceptable value: true false

  • Categories: BugFix

optimizeFakePlayerSpawn

Fix bug: lagging when spawn bot because mojang server is too slow :(

This rule force any bot use offline uuid.

  • Default value: false
  • Acceptable value: true false
  • Categories: Optimization

cceSuppressionCrashFix

Prevent CCE Suppression Crashes，watch Void0's bilibili video for more infomation.

Experimential rule

  • Default value: false
  • Acceptable value: true false
  • Categories: BugFix Experimential

removeAllCurseOfBindingArmorWhenPlayerDeadInWall

  • Remove all curse of binding armor when player dead in block(such as sand).

  • Default value: false

  • Acceptable value: true false

  • Categories: Feature

customItemDiscardTime

Custom item discard time. :)

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

allowBlockUpdateLogger

Since the blockUpdate logger can cause performance issues, a rule allowBlockUpdateLogger has been added, if this rule is disabled, all players will not be notified of block updates regardless of whether they are subscribed to this logger or not, and this rule is disabled by default.
If blockUpdate is not needed, disabling this is highly recommended.

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature Optimization

disallowRedstoneWireConnectsToOpenTrapdoor

just in >=1.20

If you want to use note block update suppression in 1.20, this may help you.

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

removeBats

Don't spawn bats!!!

  • Default value: false
  • Acceptable value: true false
  • Categories: Feature

Command

player xxx tp

  • tp to a player. commandTpToFakePlayer allowTpToRealPlayer can manage this command

player xxx tphere

  • teleport here a player. commandTpHereFakePlayer allowTpHereRealPlayer can manage this command

list -advance

  • display detail of every player

tpmanager

  • 'tpmanager tp whitelist add xxx' add prefix xxx to tp whitelist
  • 'tpmanager tp blacklist add xxx' add prefix xxx to tp blacklist
  • 'tpmanager tphere whitelist add xxx' add prefix xxx to tphere whitelist
  • 'tpmanager tphere blacklist add xxx' add prefix xxx to tphere blacklist
  • 'tpmanager tp/tphere blacklist/whitelist remove' remove a prefix

crash

  • crash!
  • /crash confirm to confirm crash

Logger

disk

  • A HUD logger，show disk usage in real time

updateSuppression

This logger is just in 1.17 and 1.18

  • Log every update suppression

cceSuppressionCrash

  • CCE suppressed crashes logger，is simular to carpet rule updateSuppressedCrash

blockUpdate

Since this logger can cause performance issues, a rule allowBlockUpdateLogger has been added, if this rule is disabled, all players will not be notified of block updates regardless of whether they are subscribed to this logger, and this rule is disabled by default.
If blockUpdate is not required, it is highly recommended to disable the allowBlockUpdateLogger rule.

  • Log all block updates