Configuration File - OreCruncher/ModpackInfo GitHub Wiki

The configuration file for the mod is straight forward. Each of the sections are outlined below. The configuration file can be found at ./minecraft/config/mpinfo.cfg.

BBCode Attributes

The following formatting codes are used when the log file format is set to bbcode. The default codes have been selected for Enjin formatting, but they can be changed as needed.

Note that the codes do not strictly have to be bbcode attributes. If this information is destined for a different rendering engine attribute tags for that engine could be used.

formatting {

    bbcode {
        S:mod.authors.begin=[color=gold]
        S:mod.authors.end=[/color]
        S:mod.credits.begin=[color=gold]
        S:mod.credits.end=[/color]
        S:mod.description.begin=[color=lightblue]
        S:mod.description.end=[/color]
        S:mod.id.begin=[color=orange]
        S:mod.id.end=[/color]
        S:mod.name.begin=[u][color=magenta][size=5]
        S:mod.name.end=[/size][/color]
        S:mod.version.begin=[color=yellow]
        S:mod.version.end=[/color][/u]
        S:mod.website.begin=[color=cyan]
        S:mod.website.end=[/color]
        S:mod.websiteURL.begin=[url]
        S:mod.websiteURL.end=[/url]
        S:modpack.authors.begin=[color=gold]
        S:modpack.authors.end=[/color]
        S:modpack.credits.begin=[color=gold]
        S:modpack.credits.end=[/color]
        S:modpack.description.begin=[color=lightblue]
        S:modpack.description.end=[/color]
        S:modpack.environment.begin=[color=lightgray]
        S:modpack.environment.end=[/color]
        S:modpack.name.begin=[color=orange][size=6]
        S:modpack.name.end=[/size][/color]
        S:modpack.version.begin=[color=yellow][size=5]
        S:modpack.version.end=[/size][/color]
        S:modpack.website.begin=[color=cyan]
        S:modpack.website.end=[/color]
        S:modpack.websiteURL.begin=[url]
        S:modpack.websiteURL.end=[/url]
    }

}

General Settings

These settings control the behavior of the mod. The fields are commented.

general {
    # Display greeting when player logs in (true|false)
    B:"Display Greeting"=true

    # Enable commands for player use (true|false)
    B:"Enable Commands"=true

    # Type of output to generate (bbcode|xml|json|text)
    S:"Output Type"=bbcode
}

Depending on the Output Type the name of the output file will change:

• bbcode or text: Modpackinfo.txt
• json: Modpackinfo.json
• xml: Modpackinfo.xml

Modpack Information

These settings are adjusted by the modpack author. This information is used to form the greeting message to the player when they log in, the output response to the /modpackinfo command, and the title information that is recorded in the output log.

modpackinfo {
    # Authors of the modpack [default: ]
    S:authors <
    >

    # Credits of the modpack
    S:credits=

    # Description of the modpack
    S:description=

    # Name of the modpack
    S:name=

    # Version of the modpack
    S:version=

    # Modpack web address
    S:website=
}