Skip to content

Commit

Permalink
doc: add rules
Browse files Browse the repository at this point in the history
  • Loading branch information
OptiJava committed Feb 21, 2024
1 parent d3139fd commit 59c2cfe
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,26 @@ Custom item discard time. :)
- 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`

## Command

### player xxx tp
Expand Down Expand Up @@ -347,3 +367,11 @@ Custom item discard time. :)
### 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
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ DispenserBlockEntity dispenserBlockEntity = (DispenserBlockEntity)blockPointerIm

### removeAllCurseOfBindingArmorWhenPlayerDeadInWall

- 顾名思义,当玩家窒息死亡时移除所有绑定诅咒盔甲 ~~腐竹再也不用用指令移除绑定诅咒南瓜头了~~
顾名思义,当玩家窒息死亡时移除所有绑定诅咒盔甲 ~~腐竹再也不用用指令移除绑定诅咒南瓜头了~~

- Default value: `false`
- Acceptable value: `true` `false`
Expand All @@ -306,6 +306,26 @@ DispenserBlockEntity dispenserBlockEntity = (DispenserBlockEntity)blockPointerIm
- Acceptable value: `true` `false`
- Categories: `Feature`

### allowBlockUpdateLogger

由于`blockUpdate`记录器可能导致性能问题,所以增加了一个规则`allowBlockUpdateLogger`,如果此规则禁用,所有玩家不论是否订阅了本记录器都不会受到方块更新的通知,并且本规则默认禁用。
\
若无需使用`blockUpdate`**强烈建议禁用**

- Default value: `false`
- Acceptable value: `true` `false`
- Categories: `Feature` `Optimization`

### disallowRedstoneWireConnectsToOpenTrapdoor

**仅限`1.20`版本及以上**

如果你想在`1.20`使用音符盒极简抑制器,这可能能帮助你

- Default value: `false`
- Acceptable value: `true` `false`
- Categories: `Feature`

## 指令

### player xxx tp
Expand Down Expand Up @@ -347,3 +367,11 @@ DispenserBlockEntity dispenserBlockEntity = (DispenserBlockEntity)blockPointerIm

### cceSuppressionCrash
- CCE更新抑制器崩溃记录,类似于carpet的`updateSuppressedCrash`

### blockUpdate

**由于本记录器可能导致性能问题,所以增加了一个规则`allowBlockUpdateLogger`,如果此规则禁用,所有玩家不论是否订阅了本记录器都不会受到方块更新的通知,并且本规则默认禁用。**
\
若无需使用`blockUpdate`**强烈建议禁用`allowBlockUpdateLogger`规则**

- 记录所有方块更新

0 comments on commit 59c2cfe

Please sign in to comment.