|
| 1 | +## Choosing the Right Engine |
| 2 | +To use Anti-Xray without the need to install additional plugins, you need to install the `Paper` engine or its forks (**such as Purpur**) on your server and select your server version. To do this on the [**Craftserve**](https://craftserve.com/) hosting platform, go to the **Settings** tab in the **Main Panel**, then select `Engine`. From the list of engines, choose the one you need and click `Install`. |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Mode Description |
| 8 | +Anti-Xray can operate in two different modes: |
| 9 | +* `engine-mode: 1`: Ores are replaced with stone, but only those that are not adjacent to an air block or liquid (water or lava). When X-ray is enabled, only ores that could not be hidden by surrounding blocks are visible. |
| 10 | + |
| 11 | +* `engine-mode: 2`: Ores are not hidden; instead, stone, andesite, and diorite are replaced with random ore deposits, making it impossible for a player to distinguish real ores from fake ones. Fake ores turn into real blocks when an air or liquid block is placed next to them. If the server experiences lag, random ores may appear while mining, but players will not be able to mine them. |
| 12 | + |
| 13 | +### Recommended Modes for the Overworld |
| 14 | + |
| 15 | +### Recommended Modes for the Nether |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Configuration Files for `1.19` |
| 20 | +There are four files where Anti-Xray is configured: |
| 21 | +* `paper-world-defaults` - Located in the **config** folder in the main server directory. This file contains settings for all worlds, meaning if a block is added here, it will be hidden in the Overworld, Nether, etc. By default, after opening the file, around line 16, you should see the following: |
| 22 | +```yml |
| 23 | +anticheat: |
| 24 | + anti-xray: |
| 25 | + enabled: false |
| 26 | + engine-mode: 1 |
| 27 | + hidden-blocks: |
| 28 | + - copper_ore |
| 29 | + - deepslate_copper_ore |
| 30 | + - gold_ore |
| 31 | + - deepslate_gold_ore |
| 32 | + - iron_ore |
| 33 | + - deepslate_iron_ore |
| 34 | + - coal_ore |
| 35 | + - deepslate_coal_ore |
| 36 | + - lapis_ore |
| 37 | + - deepslate_lapis_ore |
| 38 | + - mossy_cobblestone |
| 39 | + - obsidian |
| 40 | + - chest |
| 41 | + - diamond_ore |
| 42 | + - deepslate_diamond_ore |
| 43 | + - redstone_ore |
| 44 | + - deepslate_redstone_ore |
| 45 | + - clay |
| 46 | + - emerald_ore |
| 47 | + - deepslate_emerald_ore |
| 48 | + - ender_chest |
| 49 | +``` |
| 50 | +* `paper-world` |
| 51 | + * Located in the **world** folder |
| 52 | + * Located in the **world_nether** folder |
| 53 | + * Located in the **world_the_end** folder |
| 54 | + |
| 55 | + Each of these files contains settings for separate worlds. One does not affect the operation of another. Compared to the previous file, after opening one of these, you will see only a few lines, e.g., for `paper-world` from **world**: |
| 56 | +```yml |
| 57 | +# This is a world configuration file for Paper. |
| 58 | +# This file may start empty but can be filled with settings to override ones in the config/paper-world-defaults.yml |
| 59 | +# |
| 60 | +# World: world (minecraft:overworld) |
| 61 | +
|
| 62 | +_version: 28 |
| 63 | +``` |
| 64 | +To enable Anti-Xray, simply copy and paste the following settings into the appropriate files. |
| 65 | + |
| 66 | +## Recommended Settings for Engine-mode: 1 |
| 67 | +### For `paper-world-defaults` |
| 68 | +```yml |
| 69 | +anticheat: |
| 70 | + anti-xray: |
| 71 | + enabled: true |
| 72 | + engine-mode: 1 |
| 73 | + hidden-blocks: |
| 74 | + - chest |
| 75 | + - coal_ore |
| 76 | + - deepslate_coal_ore |
| 77 | + - copper_ore |
| 78 | + - deepslate_copper_ore |
| 79 | + - raw_copper_block |
| 80 | + - diamond_ore |
| 81 | + - deepslate_diamond_ore |
| 82 | + - emerald_ore |
| 83 | + - deepslate_emerald_ore |
| 84 | + - gold_ore |
| 85 | + - deepslate_gold_ore |
| 86 | + - iron_ore |
| 87 | + - deepslate_iron_ore |
| 88 | + - raw_iron_block |
| 89 | + - lapis_ore |
| 90 | + - deepslate_lapis_ore |
| 91 | + - redstone_ore |
| 92 | + - deepslate_redstone_ore |
| 93 | + - ancient_debris |
| 94 | + - nether_gold_ore |
| 95 | + - nether_quartz_ore |
| 96 | + lava-obscures: false |
| 97 | + max-block-height: 90 |
| 98 | + update-radius: 2 |
| 99 | + use-permission: false |
| 100 | +``` |
| 101 | +### For `paper-world` |
| 102 | +- From **world** |
| 103 | +```yml |
| 104 | +anticheat: |
| 105 | + anti-xray: |
| 106 | + enabled: true |
| 107 | + engine-mode: 1 |
| 108 | + hidden-blocks: |
| 109 | + - chest |
| 110 | + - coal_ore |
| 111 | + - deepslate_coal_ore |
| 112 | + - copper_ore |
| 113 | + - deepslate_copper_ore |
| 114 | + - raw_copper_block |
| 115 | + - diamond_ore |
| 116 | + - deepslate_diamond_ore |
| 117 | + - emerald_ore |
| 118 | + - deepslate_emerald_ore |
| 119 | + - gold_ore |
| 120 | + - deepslate_gold_ore |
| 121 | + - iron_ore |
| 122 | + - deepslate_iron_ore |
| 123 | + - raw_iron_block |
| 124 | + - lapis_ore |
| 125 | + - deepslate_lapis_ore |
| 126 | + - redstone_ore |
| 127 | + - deepslate_redstone_ore |
| 128 | + lava-obscures: false |
| 129 | + max-block-height: 64 |
| 130 | + update-radius: 2 |
| 131 | + use-permission: false |
| 132 | +``` |
| 133 | +- From **world_nether** |
| 134 | +```yml |
| 135 | +anticheat: |
| 136 | + anti-xray: |
| 137 | + enabled: true |
| 138 | + engine-mode: 1 |
| 139 | + hidden-blocks: |
| 140 | + - ancient_debris |
| 141 | + - nether_gold_ore |
| 142 | + - nether_quartz_ore |
| 143 | + max-block-height: 128 |
| 144 | +``` |
| 145 | +- From **world_the_end** |
| 146 | +```yml |
| 147 | +anticheat: |
| 148 | + anti-xray: |
| 149 | + enabled: false |
| 150 | +``` |
| 151 | +## Recommended Settings for Engine-mode: 2 |
| 152 | +### For `paper-world-defaults` |
| 153 | +```yml |
| 154 | +anticheat: |
| 155 | + anti-xray: |
| 156 | + enabled: true |
| 157 | + engine-mode: 2 |
| 158 | + hidden-blocks: |
| 159 | + - air |
| 160 | + - copper_ore |
| 161 | + - deepslate_copper_ore |
| 162 | + - raw_copper_block |
| 163 | + - diamond_ore |
| 164 | + - deepslate_diamond_ore |
| 165 | + - gold_ore |
| 166 | + - deepslate_gold_ore |
| 167 | + - iron_ore |
| 168 | + - deepslate_iron_ore |
| 169 | + - raw_iron_block |
| 170 | + - lapis_ore |
| 171 | + - deepslate_lapis_ore |
| 172 | + - redstone_ore |
| 173 | + - deepslate_redstone_ore |
| 174 | + - ancient_debris |
| 175 | + - bone_block |
| 176 | + - glowstone |
| 177 | + - magma_block |
| 178 | + - nether_bricks |
| 179 | + - nether_gold_ore |
| 180 | + - nether_quartz_ore |
| 181 | + - polished_blackstone_bricks |
| 182 | + lava-obscures: false |
| 183 | + max-block-height: 64 |
| 184 | + replacement-blocks: |
| 185 | + - chest |
| 186 | + - amethyst_block |
| 187 | + - andesite |
| 188 | + - budding_amethyst |
| 189 | + - calcite |
| 190 | + - coal_ore |
| 191 | + - deepslate_coal_ore |
| 192 | + - deepslate |
| 193 | + - diorite |
| 194 | + - dirt |
| 195 | + - emerald_ore |
| 196 | + - deepslate_emerald_ore |
| 197 | + - granite |
| 198 | + - gravel |
| 199 | + - oak_planks |
| 200 | + - smooth_basalt |
| 201 | + - stone |
| 202 | + - tuff |
| 203 | + - netherrack |
| 204 | + - soul_sand |
| 205 | + - soul_soil |
| 206 | + - basalt |
| 207 | + - blackstone |
| 208 | + update-radius: 2 |
| 209 | + use-permission: false |
| 210 | +``` |
| 211 | +### For `paper-world` |
| 212 | + |
| 213 | +- From **world** |
| 214 | +```yml |
| 215 | +anticheat: |
| 216 | + anti-xray: |
| 217 | + enabled: true |
| 218 | + engine-mode: 2 |
| 219 | + hidden-blocks: |
| 220 | + - air |
| 221 | + - copper_ore |
| 222 | + - deepslate_copper_ore |
| 223 | + - raw_copper_block |
| 224 | + - diamond_ore |
| 225 | + - deepslate_diamond_ore |
| 226 | + - gold_ore |
| 227 | + - deepslate_gold_ore |
| 228 | + - iron_ore |
| 229 | + - deepslate_iron_ore |
| 230 | + - raw_iron_block |
| 231 | + - lapis_ore |
| 232 | + - deepslate_lapis_ore |
| 233 | + - redstone_ore |
| 234 | + - deepslate_redstone_ore |
| 235 | + lava-obscures: false |
| 236 | + max-block-height: 64 |
| 237 | + replacement-blocks: |
| 238 | + - chest |
| 239 | + - amethyst_block |
| 240 | + - andesite |
| 241 | + - budding_amethyst |
| 242 | + - calcite |
| 243 | + - coal_ore |
| 244 | + - deepslate_coal_ore |
| 245 | + - deepslate |
| 246 | + - diorite |
| 247 | + - dirt |
| 248 | + - emerald_ore |
| 249 | + - deepslate_emerald_ore |
| 250 | + - granite |
| 251 | + - gravel |
| 252 | + - oak_planks |
| 253 | + - smooth_basalt |
| 254 | + - stone |
| 255 | + - tuff |
| 256 | + update-radius: 2 |
| 257 | + use-permission: false |
| 258 | +``` |
| 259 | +- From **world_nether** |
| 260 | +```yml |
| 261 | +anticheat: |
| 262 | + anti-xray: |
| 263 | + enabled: true |
| 264 | + engine-mode: 2 |
| 265 | + hidden-blocks: |
| 266 | + - air |
| 267 | + - ancient_debris |
| 268 | + - bone_block |
| 269 | + - glowstone |
| 270 | + - magma_block |
| 271 | + - nether_bricks |
| 272 | + - nether_gold_ore |
| 273 | + - nether_quartz_ore |
| 274 | + - polished_blackstone_bricks |
| 275 | + max-block-height: 128 |
| 276 | + replacement-blocks: |
| 277 | + - basalt |
| 278 | + - blackstone |
| 279 | + - gravel |
| 280 | + - netherrack |
| 281 | + - soul_sand |
| 282 | + - soul_soil |
| 283 | +``` |
| 284 | +- From **world_the_end** |
| 285 | +```yml |
| 286 | +anticheat: |
| 287 | + anti-xray: |
| 288 | + enabled: false |
| 289 | +``` |
| 290 | + |
| 291 | +## Examples of Configured Files |
| 292 | +- `paper-world-defaults` <br> |
| 293 | + |
| 294 | + |
| 295 | + |
| 296 | +- `paper-world` (Nether example) <br> |
| 297 | + |
| 298 | + |
| 299 | + |
| 300 | +## Source |
| 301 | +https://docs.papermc.io/paper/anti-xray |
0 commit comments