cli_completion_data.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
 
namespace porytiles {
 
/*
 * 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
 */
 
struct CliOptionMeta {
    std::string long_name;      
    std::string description;    
    std::string type_hint;      
    std::vector<std::string> choices;  
    bool has_negation;          
};
 
[[nodiscard]] inline std::vector<CliOptionMeta> get_cli_option_metadata()
{
    return {
        CliOptionMeta{
            "num-tiles-in-primary",
            "Number Of Tiles In Primary - The NUM_TILES_IN_PRIMARY setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-tiles-total",
            "Number Of Tiles Total - The NUM_TILES_TOTAL setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-metatiles-in-primary",
            "Number Of Metatiles In Primary - The NUM_METATILES_IN_PRIMARY setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-metatiles-total",
            "Number Of Metatiles Total - The NUM_METATILES_TOTAL setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-pals-in-primary",
            "Number Of Palettes In Primary - The NUM_PALS_IN_PRIMARY setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-pals-total",
            "Number Of Palettes Total - The NUM_PALS_TOTAL setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "max-map-data-size",
            "Max Map Data Size - The MAX_MAP_DATA_SIZE setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "num-tiles-per-metatile",
            "Number Of Tiles Per Metatile - The NUM_TILES_PER_METATILE setting from include/fieldmap.h.",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "extrinsic-transparency",
            "Extrinsic Transparency - The RGB color to treat as transparent during compilation. (format: R,G,B or R,G,B,A)",
            "color",
            {},
            false
        },
        CliOptionMeta{
            "tiles-edit-mode",
            "Tiles Edit Mode - The allowed edit mode for the tiles.png artifact.",
            "enum",
            { "locked", "patch", "optimize" },
            false
        },
        CliOptionMeta{
            "pals-edit-mode",
            "Palettes Edit Mode - The allowed edit mode for the palettes/ artifacts.",
            "enum",
            { "locked", "patch", "optimize" },
            false
        },
        CliOptionMeta{
            "pal-hints-enabled",
            "Palette Hints Enabled - Enable configured palette hints.",
            "bool",
            {},
            true
        },
        CliOptionMeta{
            "packing-strategy",
            "Packing Strategy - The palette packing algorithm to use during compilation.",
            "enum",
            { "best-fusion", "backtracking", "overload-and-remove" },
            false
        },
        CliOptionMeta{
            "tile-sharing-packing",
            "Tile Sharing Packing - Controls whether palette packing considers tile sharing.",
            "enum",
            { "off", "biased", "optimal" },
            false
        },
        CliOptionMeta{
            "tile-sharing-alignment",
            "Tile Sharing Alignment - Controls palette slot alignment strategy for tile sharing.",
            "enum",
            { "off", "greedy", "optimal" },
            false
        },
        CliOptionMeta{
            "tiles-pal-mode",
            "Tiles Palette Mode - The color mode to use when saving the tiles.png artifact.",
            "enum",
            { "true-color", "greyscale" },
            false
        },
        CliOptionMeta{
            "anim-pal-resolution-strategy",
            "Global Animation Palette Resolution Strategy - The global strategy for determining which palette to use when decompiling animation tiles.",
            "enum",
            { "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" },
            false
        },
        CliOptionMeta{
            "anim-key-frame-resolution-strategy",
            "Global Animation Key Frame Resolution Strategy - The strategy to use when decompilation encounters duplicate key frame subtiles.",
            "enum",
            { "error", "warning", "mangle" },
            false
        },
        CliOptionMeta{
            "anim-multi-pal-subtile-resolution-strategy",
            "Global Animation Multi-Pal Subtile Resolution Strategy - The strategy for handling animation subtiles referenced with multiple palettes.",
            "enum",
            { "error", "warning", "split" },
            false
        },
        CliOptionMeta{
            "frame-linking",
            "Global Frame Linking - The global default frame linking mode for animations.",
            "enum",
            { "automatic", "manual", "hybrid" },
            false
        },
        CliOptionMeta{
            "cross-tileset-anim-linking",
            "Cross-Tileset Animation Linking - Enable automatic matching of secondary tiles against primary animation key frames.",
            "bool",
            {},
            true
        },
        CliOptionMeta{
            "verify-checksums",
            "Verify Checksums - Enable or disable artifact checksum verification.",
            "bool",
            {},
            true
        },
        CliOptionMeta{
            "primary-pairing-mode",
            "Primary Pairing Mode - How a secondary tileset resolves its partner primary for compilation.",
            "enum",
            { "off", "manual", "automatic" },
            false
        },
        CliOptionMeta{
            "primary-pairing-partners",
            "Primary Pairing Partners - Tileset names to use as partner primaries in manual pairing mode.",
            "string_list",
            {},
            false
        },
        CliOptionMeta{
            "diagnostic-warnings-exclude",
            "Diagnostic Warnings Exclude - Regex patterns for warning tags to exclude.",
            "string_list",
            {},
            false
        },
        CliOptionMeta{
            "diagnostic-warnings-include",
            "Diagnostic Warnings Include - Regex patterns for warning tags to include (overrides excludes).",
            "string_list",
            {},
            false
        },
        CliOptionMeta{
            "diagnostic-remarks-exclude",
            "Diagnostic Remarks Exclude - Regex patterns for remark tags to exclude.",
            "string_list",
            {},
            false
        },
        CliOptionMeta{
            "diagnostic-remarks-include",
            "Diagnostic Remarks Include - Regex patterns for remark tags to include (overrides excludes).",
            "string_list",
            {},
            false
        },
        CliOptionMeta{
            "tileset-paths-primary-src",
            "Tileset Paths Primary Source - The directory for primary tileset Porytiles component assets.",
            "string",
            {},
            false
        },
        CliOptionMeta{
            "tileset-paths-primary-bin",
            "Tileset Paths Primary Bin - The directory for primary tileset Porymap component assets.",
            "string",
            {},
            false
        },
        CliOptionMeta{
            "tileset-paths-secondary-src",
            "Tileset Paths Secondary Source - The directory for secondary tileset Porytiles component assets.",
            "string",
            {},
            false
        },
        CliOptionMeta{
            "tileset-paths-secondary-bin",
            "Tileset Paths Secondary Bin - The directory for secondary tileset Porymap component assets.",
            "string",
            {},
            false
        },
        CliOptionMeta{
            "metatile-attr-size",
            "Metatile Attribute Size - The size in bytes of each metatile attribute entry (2 for Emerald/Ruby, 4 for FireRed).",
            "integer",
            {},
            false
        },
        CliOptionMeta{
            "tileset-animations-wire-anim-code",
            "Tileset Animations Wire Anim Code - Enable or disable automatic animation code wiring.",
            "bool",
            {},
            true
        },
    };
}
 
} // namespace porytiles