warzone_map_builder.inx - inkscape extension

<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
    <_name>Warzone Map Builder</_name>
    <id>com.warzone.upload_map</id>
    <param name="tab" type="notebook">
        <page name="about" gui-text="About">
            <label appearance="header">About Warzone Map Builder</label>
            <label>This extension enables a user to generate and upload Warzone map metadata.
                <br/><br/>It endeavors to replace all the work that would need to be done in the
                Warzone Map Editor, enabling users define their map entirely in the svg file.
                <br/><br/>The best way to use this is to create a first version of the map (v0.0)
                with no metadata in it. Duplicate that version creating v1.0, and when you are ready
                to upload metadata upload it all to v1.0. If you want to upload additional changes,
                you should always start by creating a new version by duplicating v0.0.
            </label>
        </page>
        <page name="territories" gui-text="Territories">
            <param name="territory_tab" type="notebook">
                <page name="create" gui-text="Create Territories">
                    <label appearance="header">Converts Paths into Warzone Territories</label>
                    <label>Sets a Warzone Territory ID for all selected path elements. Additionally,
                        adds a center point with example army numbers. Ensures that all paths
                        with manually set Warzone Territory IDs have been processed.
                    </label>
                    <spacer/>
                    <param name="territory_layer" type="bool" gui-text="  Move to Territories layer"
                           gui-description="If selected collect all territories into a single layer.">
                        true
                    </param>
                </page>
                <page name="name" gui-text="Territory Name">
                    <label appearance="header">Set Territory Name</label>
                    <label>Sets the territory name of a selected territory element. If the element
                        is not currently a Warzone Territory, a Warzone Territory ID will be
                        assigned and a center-point created.
                    </label>
                    <spacer/>
                    <param name="territory_name" type="string" gui-text="Territory Name:    "/>
                </page>
                <page name="center-point" gui-text="Center Point">
                    <label appearance="header">Sets a Territory's Center Point</label>
                    <label>Sets the center point for a Warzone Territory. Must select a single
                        territory and an ellipse representing the desired location of the new center
                        point.
                    </label>
                    <spacer/>
                    <param name="center_point_set_type" type="optiongroup" appearance="radio"
                           gui-text="Setting Method:"
                           gui-description="Specify the method to designate the center point.">
                        <option value="ellipse">  With an Ellipse</option>
                        <option value="default">  Reset to Default</option>
                    </param>
                </page>
            </param>
        </page>
        <page name="connections" gui-text="Connections">
            <label appearance="header">Create Connection</label>
            <label>
                Creates a connection between two selected territories if they are currently not
                connected. Can create vertically or horizontally wrapping connections.
            </label>
            <spacer/>
            <param name="connection_type" type="optiongroup" appearance="radio"
                   gui-text="Connection Type:" gui-description="Specify connection type">
                <option value="Normal">  Normal</option>
                <option value="WrapHorizontally">  Wrap Horizontally</option>
                <option value="WrapVertically">  Wrap Vertically</option>
            </param>
        </page>
        <page name="bonuses" gui-text="Bonus">
            <label appearance="header">Create or Update Bonus</label>
            <param name="bonus_name" type="string" gui-text="Bonus Name:    "
                   gui-description="Name of the bonus. Can be empty if a bonus-link is selected (unless creating a bonus)."/>
            <param name="bonus_tab" type="notebook">
                <page name="create-update" gui-text="Create/Update">
                    <param name="bonus_properties_tab" type="notebook">
                        <page name="create" gui-text="Create Bonus">
                            <label>
                                Creates a bonus. Must provide a name. If a bonus link is selected
                                color and value are optional, but if they are provided they will be
                                applied to the bonus link.
                            </label>
                        </page>
                        <page name="update" gui-text="Update Bonus">
                            <label>
                                Updates the specified bonus.
                                <br/><br/>Empty name, value, or color fields will be left unchanged.
                            </label>
                            <param name="bonus_name_update" type="string"
                                   gui-text="Update Name:    "
                                   gui-description="Name to change the bonus name to. The bonus name will be unchanged if this is empty."/>
                        </page>
                    </param>
                    <param name="bonus_value" type="string" gui-text="Army Value:    "
                           gui-description="Specify bonus value. If updating bonus, this can be left blank to leave the bonus value unchanged."/>
                    <!-- todo change to use color picker -->
                    <param name="bonus_color" type="string" gui-text="Color:    "
                           gui-description="Specify bonus color. If updating bonus, this can be left blank to leave the bonus color unchanged.">
                        #000000
                    </param>
                    <param name="bonus_link_visible" type="bool"
                           gui-text="  Bonus link should be visible"
                           gui-description="If selected, this bonus will have a visible bonus-link.">
                        true
                    </param>
                </page>
                <page name="delete" gui-text="Delete">
                    <label>
                        Deletes the bonus corresponding to the provided bonus name or selected bonus
                        link.
                    </label>
                </page>
                <page name="bonus-territories" gui-text="Add/Replace Territories">
                    <label appearance="header">Add or replace selected territories</label>
                    <spacer/>
                    <param name="bonus_territories_add_replace" type="optiongroup"
                           appearance="radio" gui-text="Add or Replace Territory:"
                           gui-description="Add or replace territories for this bonus.">
                       <option value="add">  Add territories</option>
                       <option value="replace">  Replace territories</option>
                    </param>
                </page>
            </param>
        </page>
        <page name="distributions" gui-text="Distribution Mode">
            <label appearance="header">Create or Update Distribution Mode</label>
            <param name="distribution_name" type="string" gui-text="Distribution Mode Name:    "
                   gui-description="Specify name of distribution to create, update, or delete"/>
            <param name="distribution_tab" type="notebook">
                <page name="crud" gui-text="Create/Update/Delete">
                    <param name="distribution_crud_tab" type="notebook">
                        <page name="create" gui-text="Create">
                            <label>
                                Creates a distribution mode with the given name.
                                <br/><br/>Will create a scenario distribution if scenarios are
                                specified. Scenario names should each be on a new line.
                            </label>
                        </page>
                        <page name="update" gui-text="Update">
                            <label>
                                Updates the distribution mode with the given name. Can rename the
                                distribution mode or add new scenarios.
                                <br/><br/>If converting a non-scenario distribution to a scenario
                                distribution, all territories will be removed from the distribution
                                mode.
                            </label>
                            <param name="distribution_name_update" type="string"
                                   gui-text="Update Name:    "/>
                        </page>
                        <page name="delete" gui-text="Delete">
                            <label>
                                Delete the distribution mode with the given name. If scenario names
                                are provided, will delete the specified scenarios.
                                <br/><br/>If the last scenario is deleted from a scenario
                                distribution, will convert to a non-scenario distribution.
                            </label>
                        </page>
                    </param>
                    <param name="distribution_scenario_names" type="string"
                           appearance="multiline" gui-text="Scenario Names:    "
                           gui-description="Leave empty for a normal distribution mode. For a scenario distribution, specify each scenario name on a separate line. There must be at least two scenarios."/>
                </page>
                <page name="distribution-territories" gui-text="Add/Replace Territories">
                    <label appearance="header">Add or replace selected territories<br/></label>
                    <param name="distribution_territories_add_replace" type="optiongroup"
                           appearance="radio" gui-text="Add or Replace Territory:"
                           gui-description="Add or replace territories for this distribution mode.">
                       <option value="add">  Add territories</option>
                       <option value="replace">  Replace territories</option>
                    </param>
                    <param name="distribution_territory_scenario_name" type="string"
                           gui-text="Scenario Name:    "
                           gui-description="For scenario distributions, specify scenario to add territories to."/>
                </page>
            </param>
        </page>
        <page name="upload" gui-text="Upload Metadata">
            <label appearance="header">Load Map Metadata to Warzone</label>
            <param name="upload_email" type="string" gui-text="Warzone Email Address:    "
                   gui-description="Provide the email associated with your Warzone account."/>
            <param name="upload_api_token" type="string" gui-text="Warzone API Token:    "
                   gui-description="Provide your account's API Token. See https://www.warzone.com/wiki/Get_API_Token_API for getting your API Token."/>
            <param name="upload_map_id" type="int" min="0" max="9999999"
                   gui-text="Warzone Map ID:    "
                   gui-description="Provide your map's ID number. This is the numeric part of a URL like this https://www.warzone.com/SinglePlayer?PreviewMap=55555"/>
            <param name="upload_territory_names" type="bool" gui-text="  Set Territory Names"
                   gui-description="Upload territory names to Warzone.">false</param>
            <param name="upload_territory_center_points" type="bool"
                   gui-text="  Set Territory Center Points"
                   gui-description="Upload territory center points to Warzone.">false</param>
            <param name="upload_connections" type="bool" gui-text="  Set Connections"
                   gui-description="Upload territory connections to Warzone.">false</param>
            <param name="upload_bonuses" type="bool" gui-text="  Add Bonuses"
                   gui-description="Upload bonuses to Warzone.">false</param>
            <param name="upload_territory_bonuses" type="bool"
                   gui-text="  Add Territories to Bonuses"
                   gui-description="Add territories to bonuses on Warzone.">false</param>
            <param name="upload_distribution_modes" type="bool" gui-text="  Add Distribution Modes"
                   gui-description="Upload distribution modes to Warzone.">false</param>
            <param name="upload_territory_distribution_modes" type="bool"
                   gui-text="  Add Territories to Distribution Modes"
                   gui-description="Add territories to distribution modes on Warzone.">false</param>
        </page>
    </param>
    <effect needs-live-preview="false">
        <object-type>all</object-type>
        <effects-menu>
            <submenu _name="Export"/>
        </effects-menu>
    </effect>
    <script>
        <command reldir="extensions" interpreter="python">warzone_map_builder.py</command>
    </script>
</inkscape-extension>