global.conf

Global Configuration

The global.conf file contains the global configuration settings for Sponge. This file is created in the config/sponge directory in your server folder. Many of these properties can be also overridden per-world or per-dimension type by using the config files in the subfolders of config/worlds. The following global.conf example was generated by a server running Sponge Coremod (build 516) and Forge 1.8 (build 1487).

# 1.0
#
# # If you need help with the configuration or have any questions related
# # to Sponge, join us at the IRC or drop by our forums and leave a post.
#
# # IRC: #sponge @ irc.esper.net ( http://webchat.esper.net/?channel=sponge )
# # Forums: https://forums.spongepowered.org/
#

sponge {
    commands {
        # A mapping from unqualified command alias to plugin id of the plugin
        # that should handle a certain command
        aliases=null
    }
    # Controls whether or not this config is enabled.
    # Note: If enabled, World configs override Dimension and Global,
    # and Dimension configs override Global.
    config-enabled=true
    debug {
        # Dump chunks in the event of a deadlock
        dump-chunks-on-deadlock=false
        # Dump the heap in the event of a deadlock
        dump-heap-on-deadlock=false
        # Dump the server thread on deadlock warning
        dump-threads-on-warn=false
        # Enable Java's thread contention monitoring for thread dumps
        thread-contention-monitoring=false
    }
    entity {
        # Number of colliding entities in one spot before logging a warning.
        # Set to 0 to disable
        collision-warn-size=200
        # Number of entities in one dimension before logging a warning.
        # Set to 0 to disable
        count-warn-size=0
        # Number of ticks before the fake player entry of a human is removed
        # from the tab list (range of 0 to 100 ticks).
        human-player-list-remove-delay=10
        # Controls the time in ticks for when an item despawns.
        item-despawn-rate=6000
        # Max size of an entity's bounding box before removing it.
        # Set to 0 to disable
        max-bounding-box-size=1000
        # Square of the max speed of an entity before removing it.
        # Set to 0 to disable
        max-speed=100
    }
    entity-activation-range {
        ambient-activation-range=32
        aquatic-activation-range=32
        creature-activation-range=32
        minecraft {
            ambient {
                bat=true
            }
            aquatic {
                squid=true
            }
            creature {
                chicken=true
                cow=true
                entityhorse=true
                mushroomcow=true
                ozelot=true
                pig=true
                rabbit=true
                sheep=true
                wolf=true
            }
            enabled=true
            misc {
                armorstand=true
                arrow=true
                boat=true
                fallingsand=true
                item=true
                itemframe=true
                leashknot=true
                minecartchest=true
                minecartfurnace=true
                minecarthopper=true
                minecartrideable=true
                minecarttnt=true
                painting=true
                villager=true
                villagergolem=true
                xporb=true
            }
            monster {
                blaze=true
                cavespider=true
                creeper=true
                enderman=true
                endermite=true
                ghast=true
                giant=true
                guardian=true
                lavaslime=true
                pigzombie=true
                silverfish=true
                skeleton=true
                slime=true
                snowman=true
                spider=true
                witch=true
                zombie=true
            }
        }
        misc-activation-range=16
        monster-activation-range=32
    }
    general {
        # Forces Chunk Loading on provide requests
        # (speedup for mods that don't check if a chunk is loaded)
        chunk-load-override=false
        # Disable warning messages to server admins
        disable-warnings=false
    }
    logging {
        # Log when chunks are loaded
        chunk-load=false
        # Log when chunks are unloaded
        chunk-unload=false
        # Whether to log entity collision/count checks
        entity-collision-checks=false
        # Log when living entities are destroyed
        entity-death=false
        # Log when living entities are despawned
        entity-despawn=false
        # Log when living entities are spawned
        entity-spawn=false
        # Whether to log entity removals due to speed
        entity-speed-removal=false
        # Add stack traces to dev logging
        log-stacktraces=false
    }
    modules {
        entity-activation-range=true
    }
    world {
        # Lava behaves like vanilla water when source block is removed
        flowing-lava-decay=false
        # Vanilla water source behavior - is infinite
        infinite-water-source=false
    }
}

Global Properties of Sponge

Property	Type	Default	Description
Commands
aliases	string	null	Alias will resolve conflicts when multiple plugins request a specific command. Correct syntax is <unqualified command>: <plugin name> eg. aliases= { title: myPlugin }
config-enabled	boolean	true	When true, World configs override Dimensions, and both override Global. When false, settings from Dimension and/or Global configs are used.
Debug Options
dump-chunks-on-deadlock	boolean	false	Dumps chunks in the event of a deadlock
dump-heap-on-deadlock	boolean	false	Dump the heap in the event of a deadlock
dump-threads-on-warn	boolean	false	Dump the server thread on deadlock warning
thread-contention-monitoring	boolean	false	Enable Java’s thread contention monitoring for thread dumps.
Entity Options
collision-warn-size	integer	200	Number of colliding entities in one spot before logging a warning. Set to 0 to disable.
count-warn-size	integer	0	Number of entities allowed in one dimension before logging a warning. Set to 0 to disable.
human-player-list-remove-delay	integer	10	Number of ticks before the fake player entry of a human is removed from the tab list. The allowed range is 0 - 100.
item-despawn-rate	integer	6000	The time in ticks before an item despawns.
max-bounding-box-size	integer	1000	Maximum size of an entity’s bounding box before it is removed. Set to 0 to disable.
max-speed	integer	100	Square of the maximum speed of an entity before it is removed. Set to 0 to disable
Entity Activation Range			Note that entities from Mods are automatically added to this list.
ambient-activation-range	integer	32	Range where ambient entities become active.
aquatic-activation-range	integer	32	Range where aquatic entities become active.
creature-activation-range	integer	32	Range where creatures become active.
Minecraft Creatures
Ambient (bat)	boolean	true	Use activation range on bats
Aquatic (squid)	boolean	true	Use activation range on squid.
Creature <creature>	boolean	true	Use activation range on <creature>. Permitted values: chicken, cow, entityhorse, mushroomcow, ozelot, pig, rabbit, sheep, wolf.
enabled	boolean	true	Enable activation range on Minecraft entities.
Miscellaneous Entities
Misc <entity>	boolean	true	Use activation range on <entity>. Permitted values: armorstand, arrow, boat, fallingsand, item, itemframe, leashknot, minecartchest, minecartfurnace, minecarthopper, minecartrideable, minecarttnt, painting, villager, villagergolem, xporb.
Minecraft Monsters
Monster <monster>	boolean	true	Use activation range on <monster>. Permitted values: blaze, cavespider, creeper, enderman, endermite, ghast, giant, guardian, lavaslime, pigzombie, silverfish, skeleton, slime, snowman, spider, witch, zombie.
misc-activation-range	integer	16	Range where misc entities become active.
monster-activation-range	integer	32	Range where monsters are activated.
General Settings
chunk-load-override	boolean	false	Forces chunk loading on provide requests. This is a speed-up for mods that don’t check if a chunk is loaded.
disable-warnings	boolean	false	Disable warning messages to server Admins.
Logging Options
chunk-load	boolean	false	Log when chunks are loaded.
chunk-unload	boolean	false	Log when chunks are unloaded.
entity-collision-checks	boolean	false	Whether to log entity collision/count checks.
entity-death	boolean	false	Log when living entities are destroyed.
entity-despawn	boolean	false	Log when living entities are despawned.
entity-spawn	boolean	false	Log when living entities are spawned.
entity-speed-removal	boolean	false	Whether to log entity removals due to speed.
log-stacktraces	boolean	false	Add stack traces to dev logging.
Modules
entity-activation-range	boolean	true	Enables the entity activation range settings.
World Settings
flowing-lava-decay	boolean	false	Lava behaves like vanilla water when the source block is removed, when set to true.
infinite-water-source	boolean	false	False = Default vanilla water source behaviour.

Sponge SQL Service

Sponge provides a rudimentary SQL service. The SQL properties are not created in the default global.conf file, and must be added by manually editing the file. This service permits assigning keys in the config file that can then be used by plugins.

Aliases

The keys define aliases (ie. key=url) for database connection URLs. These aliases can be used in place of database URLs in any plugin configuration that uses the Sponge services to establish database connections. An example of the completed SQL settings is provided below.

databases {
    # Provides database URLs for use by plugins
    key="jdbc:mysql://user:pass@host/database"
    localdb="jdbc:h2:config/myplugin/database.db"
}