Configuration

Configuration files are located in config/mirage/configs. The file config/mirage/map.conf associates the configurations with the worlds. This way, different worlds can share the same configuration. You can specify a default configuration per dimension and globally.

By default, Mirage automatically generates a configuration for the vanilla dimensions. Here’s what the configuration looks like for overworld:

Config {
    Cache=true
    Deobfuscation {
        NaturalRadius=1
        PlayerRadius=2
    }
    Dynamism=true
    Enabled=true
    FakeSeed=true
    WorldType="minecraft:overworld"
}
Modifiers=[
    {
        Type="hide_obvious"
        Options {
            ...
        }
    },
    {
        Type="random_block"
        Options {
            ...
        }
    },
    ...
]
Version=3

This example shows you the general structure of a configuration file, a real configuration file will be a bit different from this one. (... represents a list of elements).

Structure

A configuration file is currently divided in three parts.

Version

This field is used to hold a number that will indicate to Mirage whether the configuration is outdated or not. You should never modify this number. If the configuration is outdated, Mirage will make a backup of the file and try to update the structure to a newer version. If it’s not possible a new one will be generated.

Config

This section contains general options. Here are the different fields:

• Enabled determines whether Mirage is enabled in this world. If disabled, all other fields in Config and Modifiers will be ignored.
• Cache determines whether the cache is activated in this world. The cache can help you a lot to gain performances but it can be disabled if you have an issue with. (which should never happen).
• Dynamism determines whether dynamism is activated in this world. This allows to dynamically hide blocks depending on the player distance.
• FakeSeed whether hashed seed protection is enabled. When enabled a fake seed is used in the login and respawn packets sent to the client.
• Deobfuscation determines the radius (between 1 and 4) used to deobfuscate neighbor blocks around a block modified or updated by a player or the game itself. A low number increases protection, but can cause fake blocks to appear for a fraction of a second when a player is mining.
• WorldType is used to automatically generate a configuration adapted to the dimension.

Modifiers

This section is a list of modifier types and options. The modifiers are applied in the world in the same order as in the list. See Modifiers.