Skip to content

Commit

Permalink
Document obfuscation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Owen1212055 committed Dec 29, 2024
1 parent e8fc557 commit 145df9b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 24 deletions.
43 changes: 43 additions & 0 deletions config-specs/paper/paper-global.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
anticheat:
obfuscation:
items:
all-models:
also-obfuscate:
default: []
description: >-
Controls whether certain data components should be hidden for all items from other players. It's
generally not recommended you configure this unless you know what you are doing, as you may change
how items may look visually to other players.
dont-obfuscate:
default: ['minecraft:lodestone_tracker']
description: >-
Controls which data components should not be hidden for all items from other players. This is because they may slightly change
the item's appearance, so hiding it isn't warranted.
In this example, lodestone trackers may reveal critical locations, but hiding the location causes the
compass to shake around for other players. It's up to your digression whether you think this tradeoff is important.
sanitize-count:
default: 'true'
description: >-
Controls whether the item's count should be hidden from other players.
enable-item-obfuscation:
default: false
description: >-
Controls whether unnecessary item information (such as enchantments, lore, etc.) that can give cheat clients an advantage should be sent to other
players' clients. This may break resource packs that rely on information such as enchantments,
lore or item names when observing other players.
model-overrides:
minecraft:elytra:
also-obfuscate:
default: [ ]
description: >-
Controls the components that should also be obfuscated for items with the item model of `minecraft:elytra`.
This may be useful if you want to hide certain components not important to other items.
dont-obfuscate:
default: [ minecraft:damage ]
description: >-
Controls the components that should not be obfuscated for items with the item model of `minecraft:elytra`.
This defaults to `minecraft:damage` as elytras with 1 durability have a special texture.
sanitize-count:
default: true
description: >-
Controls whether the items with the item model of `minecraft:elytra` count should be hidden from other players.
block-updates:
disable-noteblock-updates:
default: "false"
Expand Down
24 changes: 0 additions & 24 deletions config-specs/paper/paper-world-defaults.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,30 +76,6 @@ anticheat:
With engine-mode: 3, the behavior is the same as engine-mode: 2, but the
replacement-blocks list is used to determine which blocks are used for
each vertical chunk layer.
obfuscation:
items:
hide-durability:
default: "false"
description: >-
Controls whether durability information is sent to other players'
clients. This may break resource packs that rely on durability values
when observing other players
hide-itemmeta:
default: "false"
description: >-
Controls whether unnecessary item information (such as enchantments,
items in a shulker box/bundle, etc.) that can give cheat clients an
advantage should be sent to other players' clients. This may break
resource packs that rely on information such as enchantments, lore or
item names when observing other players
hide-itemmeta-with-visual-effects:
default: "false"
description: >-
Controls whether item information that affects how an item is
displayed (such as lodestone compass positions) should be sent to
other players' clients. This information could be used by cheat
clients to give another advantage to the cheating player. However,
this will affect how certain items look when held by another player
chunks:
auto-save-interval:
default: default
Expand Down

0 comments on commit 145df9b

Please sign in to comment.