cli_option_registration.cpp

Go to the documentation of this file.

#include "porytiles/infra/cli/cli_option_registration.hpp"
 
#include <string>
 
// NOTE: DO NOT EDIT THIS FILE DIRECTLY. It is AUTO-GENERATED from config_schema.yaml.
// To add new config values or make other changes, edit config_schema.yaml and regenerate via:
//
//   uv run scripts/generate_config.py
 
namespace porytiles {
 
void register_config_options(CLI::App &app, CliOptionStorage &storage)
{
    auto *config_group = app.add_option_group("Config Options", "Override configuration values");
    config_group->footer(""); // Clear inherited footer to prevent duplication in help output
 
    // Number Of Tiles In Primary (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-tiles-in-primary",
        storage.num_tiles_in_primary,
        "Number Of Tiles In Primary - The NUM_TILES_IN_PRIMARY setting from include/fieldmap.h.");
 
    // Number Of Tiles Total (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-tiles-total",
        storage.num_tiles_total,
        "Number Of Tiles Total - The NUM_TILES_TOTAL setting from include/fieldmap.h.");
 
    // Number Of Metatiles In Primary (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-metatiles-in-primary",
        storage.num_metatiles_in_primary,
        "Number Of Metatiles In Primary - The NUM_METATILES_IN_PRIMARY setting from include/fieldmap.h.");
 
    // Number Of Metatiles Total (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-metatiles-total",
        storage.num_metatiles_total,
        "Number Of Metatiles Total - The NUM_METATILES_TOTAL setting from include/fieldmap.h.");
 
    // Number Of Palettes In Primary (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-pals-in-primary",
        storage.num_palettes_in_primary,
        "Number Of Palettes In Primary - The NUM_PALS_IN_PRIMARY setting from include/fieldmap.h.");
 
    // Number Of Palettes Total (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-pals-total",
        storage.num_palettes_total,
        "Number Of Palettes Total - The NUM_PALS_TOTAL setting from include/fieldmap.h.");
 
    // Max Map Data Size (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--max-map-data-size",
        storage.max_map_data_size,
        "Max Map Data Size - The MAX_MAP_DATA_SIZE setting from include/fieldmap.h.");
 
    // Number Of Tiles Per Metatile (std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--num-tiles-per-metatile",
        storage.num_tiles_per_metatile,
        "Number Of Tiles Per Metatile - The NUM_TILES_PER_METATILE setting from include/fieldmap.h.");
 
    // Extrinsic Transparency (Rgba32, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--extrinsic-transparency",
            storage.extrinsic_transparency,
            "Extrinsic Transparency - The RGB color to treat as transparent during compilation. (format: R,G,B or "
            "R,G,B,A, values 0-255)")
        ->type_name("R,G,B[,A]");
 
    // Ignore Triple Layer Content (bool with --flag/--no-flag, captured as "true"/"false" string)
    config_group->add_flag(
        "--ignore-triple-layer-content,!--no-ignore-triple-layer-content",
        [&storage](std::int64_t count) {
            if (count > 0) {
                storage.ignore_triple_layer_content = "true";
            }
            else if (count < 0) {
                storage.ignore_triple_layer_content = "false";
            }
            // count == 0 means neither flag was provided, leave optional empty
        },
        "Ignore Triple Layer Content - Demote the triple-layer-content-in-dual-mode error to a warning. When on, a "
        "metatile with content on all three layers compiles in dual mode by dropping one layer group instead of "
        "failing. The dropped layer follows the metatile's effective layer type: a 'layer_type' role pin if you set "
        "one, otherwise the bottom layer.");
 
    // Tiles Edit Mode (enum ArtifactEditMode, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--tiles-edit-mode",
            storage.tiles_edit_mode,
            "Tiles Edit Mode - The allowed edit mode for the tiles.png artifact.")
        ->type_name("{locked|patch|optimize}");
 
    // Palettes Edit Mode (enum ArtifactEditMode, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--pals-edit-mode",
            storage.palettes_edit_mode,
            "Palettes Edit Mode - The allowed edit mode for the palettes/ artifacts.")
        ->type_name("{locked|patch|optimize}");
 
    // Palette Hints Enabled (bool with --flag/--no-flag, captured as "true"/"false" string)
    config_group->add_flag(
        "--pal-hints-enabled,!--no-pal-hints-enabled",
        [&storage](std::int64_t count) {
            if (count > 0) {
                storage.palette_hints_enabled = "true";
            }
            else if (count < 0) {
                storage.palette_hints_enabled = "false";
            }
            // count == 0 means neither flag was provided, leave optional empty
        },
        "Palette Hints Enabled - Enable configured palette hints.");
 
    // Packing Strategy (enum PackingStrategyType, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--packing-strategy",
            storage.packing_strategy,
            "Packing Strategy - The palette packing algorithm to use during compilation.")
        ->type_name("{best-fusion|backtracking|overload-and-remove}");
 
    // Tile Sharing Packing (enum TileSharingPacking, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--tile-sharing-packing",
            storage.tile_sharing_packing,
            "Tile Sharing Packing - Controls whether palette packing considers tile sharing.")
        ->type_name("{off|biased|optimal}");
 
    // Tile Sharing Alignment (enum TileSharingAlignment, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--tile-sharing-alignment",
            storage.tile_sharing_alignment,
            "Tile Sharing Alignment - Controls palette slot alignment strategy for tile sharing.")
        ->type_name("{off|greedy|optimal}");
 
    // Tiles Palette Mode (enum TilesPaletteMode, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--tiles-pal-mode",
            storage.tiles_palette_mode,
            "Tiles Palette Mode - The color mode to use when saving the tiles.png artifact.")
        ->type_name("{true-color|greyscale}");
 
    // Global Animation Palette Resolution Strategy (enum AnimPaletteResolutionStrategy, captured as string, parsed by
    // CliOptionProvider)
    config_group
        ->add_option(
            "--anim-pal-resolution-strategy",
            storage.global_anim_palette_resolution_strategy,
            "Global Animation Palette Resolution Strategy - The global strategy for determining which palette to use "
            "when decompiling animation tiles.")
        ->type_name(
            "{scan-local-metatiles|palette-00|palette-01|palette-02|palette-03|palette-04|palette-05|palette-06|"
            "palette-07|palette-08|palette-09|palette-10|palette-11|palette-12|palette-13|palette-14|palette-15|"
            "internal-png-palette|scan-all-tilesets}");
 
    // Global Animation Key Frame Resolution Strategy (enum AnimKeyFrameResolutionStrategy, captured as string, parsed
    // by CliOptionProvider)
    config_group
        ->add_option(
            "--anim-key-frame-resolution-strategy",
            storage.global_anim_key_frame_resolution_strategy,
            "Global Animation Key Frame Resolution Strategy - The strategy to use when decompilation encounters "
            "duplicate key frame subtiles.")
        ->type_name("{error|warning|mangle}");
 
    // Global Animation Multi-Palette Subtile Resolution Strategy (enum AnimMultiPaletteSubtileResolutionStrategy,
    // captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--anim-multi-pal-subtile-resolution-strategy",
            storage.global_anim_multi_palette_subtile_resolution_strategy,
            "Global Animation Multi-Palette Subtile Resolution Strategy - The strategy for handling animation subtiles "
            "referenced with multiple palettes.")
        ->type_name("{error|warning|split}");
 
    // Global Frame Linking (enum FrameLinking, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--frame-linking",
            storage.global_frame_linking,
            "Global Frame Linking - The global default frame linking mode for animations.")
        ->type_name("{automatic|manual|hybrid}");
 
    // Cross-Tileset Animation Linking (bool with --flag/--no-flag, captured as "true"/"false" string)
    config_group->add_flag(
        "--cross-tileset-anim-linking,!--no-cross-tileset-anim-linking",
        [&storage](std::int64_t count) {
            if (count > 0) {
                storage.cross_tileset_anim_linking = "true";
            }
            else if (count < 0) {
                storage.cross_tileset_anim_linking = "false";
            }
            // count == 0 means neither flag was provided, leave optional empty
        },
        "Cross-Tileset Animation Linking - Enable automatic matching of secondary tiles against primary animation key "
        "frames.");
 
    // Verify Checksums (bool with --flag/--no-flag, captured as "true"/"false" string)
    config_group->add_flag(
        "--verify-checksums,!--no-verify-checksums",
        [&storage](std::int64_t count) {
            if (count > 0) {
                storage.verify_checksums = "true";
            }
            else if (count < 0) {
                storage.verify_checksums = "false";
            }
            // count == 0 means neither flag was provided, leave optional empty
        },
        "Verify Checksums - Enable or disable artifact checksum verification.");
 
    // Primary Pairing Mode (enum PrimaryPairingMode, captured as string, parsed by CliOptionProvider)
    config_group
        ->add_option(
            "--primary-pairing-mode",
            storage.primary_pairing_mode,
            "Primary Pairing Mode - How a secondary tileset resolves its partner primary for compilation.")
        ->type_name("{off|manual|automatic}");
 
    // Primary Pairing Partners (std::vector<std::string>, multi-value)
    config_group->add_option(
        "--primary-pairing-partners",
        storage.primary_pairing_partners,
        "Primary Pairing Partners - Tileset names to use as partner primaries in manual pairing mode.");
 
    // Diagnostic Warnings Exclude (std::vector<std::string>, multi-value)
    config_group->add_option(
        "--diagnostic-warnings-exclude",
        storage.diagnostic_warnings_exclude,
        "Diagnostic Warnings Exclude - Regex patterns for warning tags to exclude (overrides includes).");
 
    // Diagnostic Warnings Include (std::vector<std::string>, multi-value)
    config_group->add_option(
        "--diagnostic-warnings-include",
        storage.diagnostic_warnings_include,
        "Diagnostic Warnings Include - Regex patterns for warning tags to show. Warnings are hidden unless a pattern "
        "matches their tag.");
 
    // Diagnostic Remarks Exclude (std::vector<std::string>, multi-value)
    config_group->add_option(
        "--diagnostic-remarks-exclude",
        storage.diagnostic_remarks_exclude,
        "Diagnostic Remarks Exclude - Regex patterns for remark tags to exclude (overrides includes).");
 
    // Diagnostic Remarks Include (std::vector<std::string>, multi-value)
    config_group->add_option(
        "--diagnostic-remarks-include",
        storage.diagnostic_remarks_include,
        "Diagnostic Remarks Include - Regex patterns for remark tags to show. Remarks are hidden unless a pattern "
        "matches their tag.");
 
    // Tileset Paths Primary Source (std::string)
    config_group->add_option(
        "--tileset-paths-primary-src",
        storage.tileset_paths_primary_src,
        "Tileset Paths Primary Source - The directory for primary tileset Porytiles component assets.");
 
    // Tileset Paths Primary Bin (std::string)
    config_group->add_option(
        "--tileset-paths-primary-bin",
        storage.tileset_paths_primary_bin,
        "Tileset Paths Primary Bin - The directory for primary tileset Porymap component assets.");
 
    // Tileset Paths Secondary Source (std::string)
    config_group->add_option(
        "--tileset-paths-secondary-src",
        storage.tileset_paths_secondary_src,
        "Tileset Paths Secondary Source - The directory for secondary tileset Porytiles component assets.");
 
    // Tileset Paths Secondary Bin (std::string)
    config_group->add_option(
        "--tileset-paths-secondary-bin",
        storage.tileset_paths_secondary_bin,
        "Tileset Paths Secondary Bin - The directory for secondary tileset Porymap component assets.");
 
    // Metatile Attribute Size (optional std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--metatile-attribute-size",
        storage.metatile_attribute_size,
        "Metatile Attribute Size - Pins the size in bytes of each metatile attribute entry (1, 2, or 4). When unset, "
        "Porytiles derives the size from the resolved attribute field masks, which struct Tileset's declared element "
        "width must corroborate exactly. Must be set explicitly on projects that declare more than one mask layout "
        "(pokeemerald-expansion), one value per build flavor, and on projects whose masks and struct Tileset "
        "declaration disagree or whose declaration is unusable. Project-global.");
 
    // Metatile Attribute Declaration Size (optional std::size_t, captured as string, parsed by CliOptionProvider)
    config_group->add_option(
        "--metatile-attribute-declaration-size",
        storage.metatile_attribute_declaration_size,
        "Metatile Attribute Declaration Size - The declared element width in bytes (1, 2, or 4) for generated "
        "gMetatileAttributes_* C declarations (const uN / INCBIN_UN). Normally inferred from struct Tileset's "
        "metatileAttributes member in include/global.fieldmap.h. Required when that declaration is missing, "
        "unreadable, or not a pointer to u8, u16, or u32, since nothing else in a project implies this width. "
        "Project-global.");
 
    // Tileset Animations Wire Anim Code (bool with --flag/--no-flag, captured as "true"/"false" string)
    config_group->add_flag(
        "--tileset-animations-wire-anim-code,!--no-tileset-animations-wire-anim-code",
        [&storage](std::int64_t count) {
            if (count > 0) {
                storage.tileset_animations_wire_anim_code = "true";
            }
            else if (count < 0) {
                storage.tileset_animations_wire_anim_code = "false";
            }
            // count == 0 means neither flag was provided, leave optional empty
        },
        "Tileset Animations Wire Anim Code - Enable or disable automatic animation code wiring.");
}
 
} // namespace porytiles