gfx_sheet_png_commands.h

Go to the documentation of this file.

#ifndef YAZE_CLI_HANDLERS_GRAPHICS_GFX_SHEET_PNG_COMMANDS_H_
#define YAZE_CLI_HANDLERS_GRAPHICS_GFX_SHEET_PNG_COMMANDS_H_
 
#include "cli/service/resources/command_handler.h"
 
namespace yaze {
namespace cli {
 
// Palette specs shared by gfx-export and gfx-import:
//   gray                      8-step grayscale (default)
//   rgb:#RRGGBB,...           exactly 8 colors for indices 0-7
//   room-bg:<room>:<row>      explicit LEFT half of background CGRAM row 0-7
//   room-slot:<room>:<slot>:<row>  loaded slot's palette half (single sheet)
//   room-sprite:<room>:<row>  dungeon room sprite palette (OAM row 0-7);
//                             the high half for sheets vanilla loads there
 
class GfxExportCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "gfx-export"; }
  std::string GetUsage() const override {
    return "gfx-export --sheet <id> --png <file> [--block <0-15>] "
           "[--count <n>] [--palette gray|rgb:...|room-bg:<room>:<row>|"
           "room-sprite:<room>:<row>|room-slot:<room>:<slot>:<row>] [--json "
           "<file>]";
  }
  std::string GetDefaultFormat() const override { return "json"; }
  std::string GetOutputTitle() const override { return "Graphics Export"; }
  bool RequiresRom() const override { return true; }
  Descriptor Describe() const override {
    Descriptor desc;
    desc.display_name = "gfx-export";
    desc.summary =
        "Export a graphics sheet (or 16x16 block range) to an "
        "indexed PNG with a chosen palette.";
    return desc;
  }
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override;
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class GfxImportCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "gfx-import"; }
  std::string GetUsage() const override {
    return "gfx-import --sheet <id> --png <file> [--block <0-15>] "
           "[--palette ...] [--diff-png <file>] "
           "[--project-context <path.yaze>] "
           "(--dry-run | --write --out <rom file>)";
  }
  std::string GetDefaultFormat() const override { return "json"; }
  std::string GetOutputTitle() const override { return "Graphics Import"; }
  bool RequiresRom() const override { return true; }
  Descriptor Describe() const override {
    Descriptor desc;
    desc.display_name = "gfx-import";
    desc.summary =
        "Import an indexed PNG into a graphics sheet: preview the "
        "exact changes, then write a new ROM file.";
    return desc;
  }
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override;
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class GfxRoomExportCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "gfx-room-export"; }
  std::string GetUsage() const override {
    return "gfx-room-export --room <id> (--png <file> | --out-dir <new-dir>) "
           "[--row <0-7>] "
           "[--palette ...] [--json <file>]";
  }
  std::string GetDefaultFormat() const override { return "json"; }
  std::string GetOutputTitle() const override {
    return "Room Background Export";
  }
  bool RequiresRom() const override { return true; }
  Descriptor Describe() const override {
    Descriptor desc;
    desc.display_name = "gfx-room-export";
    desc.summary =
        "Export a dungeon room's background sheets to one PNG "
        "with the room palette, and list the rooms that share "
        "them.";
    return desc;
  }
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override;
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class GfxRoomImportCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "gfx-room-import"; }
  std::string GetUsage() const override {
    return "gfx-room-import --room <id> --png <file> [--row <0-7>] "
           "[--palette ...] [--project-context <path.yaze>] "
           "(--dry-run | --write --out <rom file>)";
  }
  std::string GetDefaultFormat() const override { return "json"; }
  std::string GetOutputTitle() const override {
    return "Room Background Import";
  }
  bool RequiresRom() const override { return true; }
  Descriptor Describe() const override {
    Descriptor desc;
    desc.display_name = "gfx-room-import";
    desc.summary =
        "Import an edited room background PNG into the sheets it "
        "changes.";
    return desc;
  }
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override;
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
}  // namespace cli
}  // namespace yaze
 
#endif  // YAZE_CLI_HANDLERS_GRAPHICS_GFX_SHEET_PNG_COMMANDS_H_