Module Core - Steell/Ultimate-Mapchooser GitHub Wiki

The Core "module" is the only module required by Ultimate Mapchooser. It is what handles the logic behind excluding and weighting maps, as well as hooking all of the natives and forwards together which allows other modules to extend Ultimate Mapchooser. In short, without Core, UMC modules cannot communicate with each other.

Core also contains a few universal settings which control some general behavior of votes.

Core defines two map group options, maps_invote and display-template, and two map options, display and nominate_group.

"umc_mapcycle"
{
    "A Group"
    {
        "maps_invote"  "X"
        "display-template"  "TEMPLATE_STRING"
        ...

        "A Map"
        {
            "display"  "DISPLAY_STRING"
            "nominate_group"  "GROUP_NAME"
            ...
        }
    }
    ...
}

Where X is the number of maps which should appear in the vote (integer greater than or equal to 0), TEMPLATE_STRING is a string that will be displayed for any maps from the group in a vote (it can contain the sub-string "{MAP}" which will be replaced with the name of the map), and DISPLAY_STRING is a string that will be displayed for that map in a vote, overriding whatever was specified by display-template.

GROUP_NAME is the name of a map group which you want this map to be associated with if it is nominated. If left blank, the name of the group the map belongs to is used (in this example, "A Group"). This is particularly useful if you are using the Tiered Nomination Menu (see sm_umc_nominate_tiermenu in the Nomination module), since you can then design this UMC-Mapcycle for the nomination menu and use a UMC-Mapcycle with different groups for other modules.

Core provides the following commands:

• sm_umc_reload_mapcycles - Requests that all modules reload their UMC-Mapcycles.
• sm_umc_setnextmap <mapname> - Sets the next map (same functionality as was built into the original mapchooser.smx)
• sm_umc_stopvote - Stops an Ultimate Mapchooser vote currently in progress.
• sm_umc_displaymaplists <0|1> - Displays all maplists being used by UMC. Pass 1 as an argument to see them after being filtered through UMC Map Exclusion.

The cvar list for the Core module is located in cfg/sourcemod/ultimate-mapchooser.cfg.