Configuration File

Global Settings

Integers

Key	Description	Default Value
EngineMode	1 - Replace target blocks with specified block 2 - Replace target blocks with a random block	2
MaxLoadedCacheFiles	Number of files open for caching	64
DeleteCacheFilesAfterDays	Number of days of "inactivity" of cache file after which it will be automatically deleted. When specified 0 then feature is disabled	0
InitialRadius	Radius to search for transparent blocks when the initial chunks are sent. Recommended to set value less than 3.	1
UpdateRadius	This value determines how many blocks within a certain radius will be revealed when a block change. Triggered when block is hit, destroyed or changed. Recommended to set value less than 4.	2

Boolean

Key	Description	Default Value
Enabled	Whether to run obfuscation engines or not	true
UseCache	Use a caching system to reduce CPU load.	true
UpdateOnDamage	Update nearby blocks when a block is damaged	true
NoObfuscationForOps	Ops have permission to see the real world	false
NoObfuscationForPermission	Permissions node owners have permission to see the real world	false
NoObfuscationForMetadata	When it has True value then players with tag specified in NoObfuscationForMetadataTagName see non-obuscated world. Useful for NPC players (for example in Citizens plugin)	true
LoginNotification	Notifies OP and players with permissions that Orebfuscator is disabled for them.	true

Lists

Key	Description	Default Value
TransparentBlocks	Custom list of blocks which should be considered as transparent.
NonTransparentBlocks	Custom list of blocks which should be considered as non-transparent.

Strings

Key	Description	Default Value
CacheLocation	Relative path to the folder where cache files will be stored.	orebfuscator_cache
NoObfuscationForMetadataTagName	Look at NoObfuscationForMetadata description for details	NPC

List of worlds

List of worlds could contain settings either by world type or by world name. There are 4 types of worlds:

• DEFAULT is the base set of settings for all worlds
• NORMAL is the set of settings for worlds with NORMAL environment
• NETHER is the set of settings for worlds with NETHER environment
• THE_END is the set of settings for worlds with THE_END environment

World settings by types NORMAL, NETHER and THE_END always inherits DEFAULT world type settings. This means that for example it is possible to make Orebfuscator enabled for all worlds by specifying this in DEFAULT settings and override this in another world settings.

World settings by names always inherits settings for world type of appropriate environment.

List of worlds is specified in Worlds section.

Each world is identified by custom unique key and could have following settings:

Basic settings

Key	Description	Default Value
Types	List of world types
Names	List of world names
Enabled	Specifies if obfuscation is enabled for these worlds	true
AntiTexturePackAndFreecam	Protection against x-ray texture packs and freecam.	true
AirGeneratorMaxChance	Chance that the AntiTexturePackAndFreecam feature generates an air block	43
BypassObfuscationForSignsWithText	When True then obfuscation will be bypassed for sign blocks with text	false
DarknessHideBlocks	Hide blocks from DarknessObfuscateBlocks when light level is 0	false
DarknessBlocks	Blocks to obfuscate using DarknessHideBlocks rule
Mode1Block	Obfuscation block for Engine Mode 1	STONE
ObfuscateBlocks	Blocks to obfuscate. Put ores and chest here.
RandomBlocks	Used when EngineMode is 2 List of blocks used to randomly replace target blocks with when obfuscating. Tile entities (such as chests, signs and etc) cannot be used as random blocks.

ProximityHider

Stores keys under ProximityHider subsection

Key	Description	Default Value
Enabled	Specifies if ProximityHider is enabled	true
Distance	Distance used to show blocks hidden by ProximityHider	8
UseSpecialBlock	Use SpecialBlock for obfuscation instead of from the Engine (stone for Engine 1 and random block for Engine 2).	true
SpecialBlock	Block used for obfuscation in ProximityHider	STONE
ObfuscateAboveY	true - will be obfuscated blocks above or at Y level false - will be obfuscated blocks below or at Y level	false
Y	Y value for ObfuscateAboveY rule	255
ProximityHiderBlocks	List of blocks to obfuscate
ProximityHiderBlockSettings	List of specific settings for blocks. For example it is possible to specify that SIGN will be obfuscated only below sea level, but above it - no, this is useful to show normal signs in towns and hide them in undeground warehouses

ProximityHiderBlockSettings

Each item in the list has key which is either block name or block id and could have following settings:

Key	Description
ObfuscateAboveY	The same as global ObfuscateAboveY for ProximityHider but specific for block
Y	The same as global Y for ProximityHider but specific for block

Example:

ProximityHiderBlockSettings:
  SIGN_POST:
    Y: 51
    ObfuscateAboveY: false
  WALL_SIGN:
    Y: 51
    ObfuscateAboveY: false

Example: how to disable or enable worlds

For example we need to disable two worlds - world_nether and world_the_end In this case new sub-section could be added under Worlds section:

  DisabledWorlds:
    Names:
    - world_nether
    - world_the_end
    Enabled: false

Draw attention that I chosen name DisabledWorlds for sub-section. Actually could be chosen any name, the only requirement is that this name should be unique under Worlds section.

For example now we need to make obfuscation disabled for all world by default and enable it only for some worlds. In this case Enabled attribute for sub-section for world type DEFAULT should be set for false. By default sub-section name is Default:

Worlds:
  Default:
    Types:
    - DEFAULT
    Enabled: false

Then create new sub-section where specified enabled worlds:

  EnabledWorlds:
    Names:
    - world_normal
    Enabled: true