yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
dungeon_commands.h
Go to the documentation of this file.
1#ifndef YAZE_SRC_CLI_HANDLERS_DUNGEON_COMMANDS_H_
2#define YAZE_SRC_CLI_HANDLERS_DUNGEON_COMMANDS_H_
3
4#include <string_view>
5
7
8namespace yaze {
9namespace cli {
10namespace handlers {
11
12// Writes the dedicated seven-record dungeon spawn schema. If object_title is
13// non-empty, the report is nested under an object with that name.
14absl::Status WriteDungeonSpawnPointReport(Rom* rom, int spawn_id,
15 resources::OutputFormatter& formatter,
16 std::string_view object_title);
17
22 public:
23 std::string GetName() const { return "dungeon-list-sprites"; }
24 std::string GetDescription() const {
25 return "List all sprites in a dungeon room";
26 }
27 std::string GetUsage() const {
28 return "dungeon-list-sprites --room <room_id> [--sprite-registry <path>] "
29 "[--format <json|text>]";
30 }
31
32 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
33 return parser.RequireArgs({"room"});
34 }
35
36 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
37 resources::OutputFormatter& formatter) override;
38};
39
44 public:
45 std::string GetName() const { return "dungeon-describe-room"; }
46 std::string GetDescription() const {
47 return "Get detailed description of a dungeon room";
48 }
49 std::string GetUsage() const {
50 return "dungeon-describe-room --room <room_id> [--sprite-registry <path>] "
51 "[--include-objects] [--format <json|text>]";
52 }
53
54 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
55 return parser.RequireArgs({"room"});
56 }
57
58 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
59 resources::OutputFormatter& formatter) override;
60};
61
66 public:
67 std::string GetName() const { return "dungeon-list-chests"; }
68 std::string GetDescription() const {
69 return "List chest contents for dungeon rooms";
70 }
71 std::string GetUsage() const {
72 return "dungeon-list-chests [--room <room_id>] [--format <json|text>]";
73 }
74
75 absl::Status ValidateArgs(
76 const resources::ArgumentParser& /*parser*/) override {
77 return absl::OkStatus();
78 }
79
80 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
81 resources::OutputFormatter& formatter) override;
82};
83
88 public:
89 std::string GetName() const { return "dungeon-get-entrance"; }
90 std::string GetDescription() const {
91 return "Get entrance metadata for a dungeon room";
92 }
93 std::string GetUsage() const {
94 return "dungeon-get-entrance --entrance <entrance_id> [--spawn] "
95 "[--format <json|text>]";
96 }
97
98 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
99 return parser.RequireArgs({"entrance"});
100 }
101
102 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
103 resources::OutputFormatter& formatter) override;
104};
105
110 public:
111 std::string GetName() const { return "dungeon-export-room"; }
112 std::string GetDescription() const {
113 return "Export room data to JSON format";
114 }
115 std::string GetUsage() const {
116 return "dungeon-export-room --room <room_id> [--format <json|text>]";
117 }
118
119 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
120 return parser.RequireArgs({"room"});
121 }
122
123 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
124 resources::OutputFormatter& formatter) override;
125};
126
131 public:
132 std::string GetName() const { return "dungeon-list-objects"; }
133 std::string GetDescription() const {
134 return "List all objects in a dungeon room";
135 }
136 std::string GetUsage() const {
137 return "dungeon-list-objects --room <room_id> [--format <json|text>]";
138 }
139
140 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
141 return parser.RequireArgs({"room"});
142 }
143
144 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
145 resources::OutputFormatter& formatter) override;
146};
147
152 public:
153 std::string GetName() const { return "dungeon-get-room-tiles"; }
154 std::string GetDescription() const {
155 return "Get tile data for a dungeon room";
156 }
157 std::string GetUsage() const {
158 return "dungeon-get-room-tiles --room <room_id> [--format <json|text>]";
159 }
160
161 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
162 return parser.RequireArgs({"room"});
163 }
164
165 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
166 resources::OutputFormatter& formatter) override;
167};
168
173 public:
174 std::string GetName() const { return "dungeon-set-room-property"; }
175 std::string GetDescription() const {
176 return "Set a property on a dungeon room";
177 }
178 std::string GetUsage() const {
179 return "dungeon-set-room-property --room <room_id> --property <property> "
180 "--value <value> [--manifest <path>] [--format <json|text>]";
181 }
182
183 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
184 return parser.RequireArgs({"room", "property", "value"});
185 }
186
187 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
188 resources::OutputFormatter& formatter) override;
189};
190
195 public:
196 std::string GetName() const { return "dungeon-room-header"; }
197 std::string GetDescription() const {
198 return "Read raw room header bytes for debugging ROM address issues";
199 }
200 std::string GetUsage() const {
201 return "dungeon-room-header --room <room_id> [--format <json|text>]";
202 }
203
204 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
205 return parser.RequireArgs({"room"});
206 }
207
208 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
209 resources::OutputFormatter& formatter) override;
210};
211
221 public:
222 std::string GetName() const { return "dungeon-generate-track-collision"; }
223 std::string GetDescription() const {
224 return "Generate collision overlay from rail objects for minecart rooms";
225 }
226 std::string GetUsage() const {
227 return "dungeon-generate-track-collision --room <room_id> | "
228 "--rooms <hex,hex,...> "
229 "[--write] [--preserve-stops] [--visualize] [--promote-switch X,Y] "
230 "[--project-context <path.yaze|path.yazeproj>] "
231 "[--format <json|text>]";
232 }
233
234 absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
235 // Accept either --room (single) or --rooms (batch)
236 if (parser.GetString("room").has_value() ||
237 parser.GetString("rooms").has_value()) {
238 return absl::OkStatus();
239 }
240 return absl::InvalidArgumentError("Either --room or --rooms is required");
241 }
242
243 absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
244 resources::OutputFormatter& formatter) override;
245};
246
247} // namespace handlers
248} // namespace cli
249} // namespace yaze
250
251#endif // YAZE_SRC_CLI_HANDLERS_DUNGEON_COMMANDS_H_
The Rom class is used to load, save, and modify Rom data. This is a generic SNES ROM container and do...
Definition rom.h:28
Command handler for describing a dungeon room.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetName() const
Get the command name.
std::string GetUsage() const
Get the command usage string.
Command handler for exporting room data.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetUsage() const
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const
Get the command name.
Generate track collision data from rail objects in a room.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetUsage() const
Get the command usage string.
Command handler for inspecting a dungeon entrance.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetUsage() const
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetName() const
Get the command name.
std::string GetUsage() const
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const
Get the command name.
Command handler for listing chest items in dungeon rooms.
std::string GetName() const
Get the command name.
absl::Status ValidateArgs(const resources::ArgumentParser &) override
Validate command arguments.
std::string GetUsage() const
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Command handler for listing objects in a room.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const
Get the command name.
std::string GetUsage() const
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Command handler for listing sprites in a dungeon room.
std::string GetName() const
Get the command name.
std::string GetUsage() const
Get the command usage string.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
Command handler for reading raw room header bytes (diagnostic)
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
std::string GetName() const
Get the command name.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetUsage() const
Get the command usage string.
Command handler for setting room properties.
std::string GetUsage() const
Get the command usage string.
absl::Status ValidateArgs(const resources::ArgumentParser &parser) override
Validate command arguments.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
std::string GetName() const
Get the command name.
Utility for parsing common CLI argument patterns.
std::optional< std::string > GetString(const std::string &name) const
Parse a named argument (e.g., –format=json or –format json)
absl::Status RequireArgs(const std::vector< std::string > &required) const
Validate that required arguments are present.
Base class for CLI command handlers.
Utility for consistent output formatting across commands.
absl::Status WriteDungeonSpawnPointReport(Rom *rom, int spawn_id, resources::OutputFormatter &formatter, std::string_view object_title)