gametorch-cli 0.2.1

Command-line interface for GameTorch, wrapping the official Rust SDK.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
//! Opt-in live CLI tests that **spend credits**.
//!
//! Enabled with `GAMETORCH_LIVE_SPEND=1` plus `GAMETORCH_API_KEY`. Each test
//! creates its own project and deletes it at the end unless
//! `GAMETORCH_KEEP_PROJECT=1`. Approximate cost per run: sprite ~5 credits,
//! sound ~4 credits, 4s `ash` animation ~73 credits plus frame generation.

mod common;

use std::path::PathBuf;

use common::{
    create_project, env_enabled, finish_project, has_api_key, run_json, short, wait_animation,
    wait_frames, wait_sound, wait_sprite,
};

macro_rules! require {
    () => {
        if !has_api_key() || !env_enabled("GAMETORCH_LIVE_SPEND") {
            eprintln!("skipping: set GAMETORCH_LIVE_SPEND=1 and GAMETORCH_API_KEY");
            return;
        }
    };
}

fn temp_dir() -> PathBuf {
    let dir = std::env::temp_dir().join(format!("gametorch-cli-{}", short()));
    std::fs::create_dir_all(&dir).expect("create temp dir");
    dir
}

fn first_available_model(kind: &str) -> String {
    let value = run_json(&["catalog", kind]);
    let models = value["image_models"]
        .as_array()
        .cloned()
        .unwrap_or_default();
    models
        .iter()
        .find(|model| model["available"] == true)
        .or_else(|| models.first())
        .map(|model| model["id"].as_str().unwrap().to_string())
        .expect("no image models")
}

fn label_id(project: &str, prefix: &str) -> String {
    let label = run_json(&[
        "label",
        "create",
        "--project",
        project,
        "--name",
        &format!("cli-{prefix}-{}", short()),
    ]);
    label["id"].as_str().unwrap().to_string()
}

#[test]
fn sprite_generation_full_flow() {
    require!();
    let (project, slug) = create_project("Sprite Spend Test");
    let image_model = first_available_model("sprite");

    let job = run_json(&[
        "sprite",
        "generate",
        "--project",
        &project,
        "--prompt",
        "a friendly red fox, side view, game sprite",
        "--mode",
        "single",
        "--image-model",
        &image_model,
    ]);
    let generation = wait_sprite(job["id"].as_str().unwrap());
    assert_eq!(generation["status"], "succeeded");
    let asset = generation["assets"][0]["id"].as_str().unwrap().to_string();

    // Naming.
    let named = run_json(&["sprite", "asset", "rename", &asset, "Hero Fox"]);
    assert_eq!(named["name"], "Hero Fox");

    // Metadata is additive (merge); --remove deletes keys, then re-apply.
    let tagged = run_json(&[
        "sprite",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "filepath=/foo/bar/sprites/hero.png",
    ]);
    assert_eq!(tagged["metadata"]["filepath"], "/foo/bar/sprites/hero.png");
    let merged = run_json(&[
        "sprite",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "variant=background",
    ]);
    assert_eq!(merged["metadata"]["filepath"], "/foo/bar/sprites/hero.png");
    assert_eq!(merged["metadata"]["variant"], "background");
    let cleared = run_json(&[
        "sprite", "asset", "metadata", &asset, "--remove", "filepath", "--remove", "variant",
    ]);
    assert!(cleared["metadata"].as_object().unwrap().is_empty());
    run_json(&[
        "sprite",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "filepath=/foo/bar/sprites/hero.png",
    ]);

    // Labels add, remove, then re-apply.
    let label = label_id(&project, "sprite");
    // Use the label's actual name by listing it.
    let labels = run_json(&["label", "list", "--project", &project]);
    let label_name = labels["labels"]
        .as_array()
        .unwrap()
        .iter()
        .find(|l| l["id"].as_str() == Some(label.as_str()))
        .map(|l| l["name"].as_str().unwrap().to_string())
        .unwrap();
    let associated = run_json(&[
        "label",
        "associate",
        "--asset",
        &asset,
        "--name",
        &label_name,
    ]);
    assert!(associated["labels"]
        .as_array()
        .unwrap()
        .iter()
        .any(|v| v == &serde_json::Value::String(label_name.clone())));
    let removed = run_json(&["label", "remove", "--asset", &asset, "--name", &label_name]);
    assert!(!removed["labels"]
        .as_array()
        .unwrap()
        .iter()
        .any(|v| v == &serde_json::Value::String(label_name.clone())));
    run_json(&[
        "label",
        "associate",
        "--asset",
        &asset,
        "--name",
        &label_name,
    ]);

    // Archive / unarchive.
    let archived = run_json(&["sprite", "asset", "archive", &asset]);
    assert!(archived["archived_at"].is_string());
    let unarchived = run_json(&["sprite", "asset", "unarchive", &asset]);
    assert!(unarchived["archived_at"].is_null());

    // Download content.
    let dir = temp_dir();
    let path = dir.join("hero.png");
    common::run_ok(&[
        "sprite",
        "asset",
        "content",
        &asset,
        "--output",
        path.to_str().unwrap(),
    ]);
    assert!(std::fs::metadata(&path).unwrap().len() > 0);

    finish_project(&slug);
}

#[test]
fn sound_generation_full_flow() {
    require!();
    let (project, slug) = create_project("Sound Spend Test");
    let models = run_json(&["catalog", "sound"]);
    let sound_model = models["model"]["id"].as_str().unwrap().to_string();
    let format = models["default_format"].as_str().unwrap().to_string();

    let job = run_json(&[
        "sound",
        "generate",
        "--project",
        &project,
        "--prompt",
        "a single sword unsheathing, then a heavy metal thud",
        "--sound-model",
        &sound_model,
        "--response-format",
        &format,
    ]);
    let generation = wait_sound(job["id"].as_str().unwrap());
    assert_eq!(generation["status"], "succeeded");
    let asset = generation["assets"][0]["id"].as_str().unwrap().to_string();

    let named = run_json(&["sound", "asset", "rename", &asset, "Sword Unsheath"]);
    assert_eq!(named["name"], "Sword Unsheath");

    // Metadata is additive (merge); --remove deletes keys, then re-apply.
    let tagged = run_json(&[
        "sound",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "filepath=/foo/bar/audio/sword-unsheath.mp3",
    ]);
    assert_eq!(
        tagged["metadata"]["filepath"],
        "/foo/bar/audio/sword-unsheath.mp3"
    );
    let merged = run_json(&[
        "sound",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "variant=background",
    ]);
    assert_eq!(
        merged["metadata"]["filepath"],
        "/foo/bar/audio/sword-unsheath.mp3"
    );
    let cleared = run_json(&[
        "sound", "asset", "metadata", &asset, "--remove", "filepath", "--remove", "variant",
    ]);
    assert!(cleared["metadata"].as_object().unwrap().is_empty());
    run_json(&[
        "sound",
        "asset",
        "metadata",
        &asset,
        "--metadata",
        "filepath=/foo/bar/audio/sword-unsheath.mp3",
    ]);

    let label = label_id(&project, "sound");
    let labels = run_json(&["label", "list", "--project", &project]);
    let label_name = labels["labels"]
        .as_array()
        .unwrap()
        .iter()
        .find(|l| l["id"].as_str() == Some(label.as_str()))
        .map(|l| l["name"].as_str().unwrap().to_string())
        .unwrap();
    run_json(&[
        "label",
        "associate",
        "--sound",
        &asset,
        "--name",
        &label_name,
    ]);

    let dir = temp_dir();
    let path = dir.join("sound.mp3");
    common::run_ok(&[
        "sound",
        "asset",
        "content",
        &asset,
        "--output",
        path.to_str().unwrap(),
    ]);
    assert!(std::fs::metadata(&path).unwrap().len() > 0);

    finish_project(&slug);
}

#[test]
fn animation_generation_exports_and_saved_animation() {
    require!();
    let (project, slug) = create_project("Animation Spend Test");

    let job = run_json(&[
        "animation",
        "generate",
        "--project",
        &project,
        "--prompt",
        "the hero draws her sword and raises it overhead",
        "--animation-model",
        "ash",
        "--duration",
        "4",
    ]);
    let id = job["id"].as_str().unwrap().to_string();
    let run = wait_animation(&id);
    assert_eq!(run["status"], "succeeded");

    if run["frames"]
        .as_array()
        .map(|f| f.is_empty())
        .unwrap_or(true)
    {
        run_json(&[
            "animation",
            "frames",
            "generate",
            "--project",
            &project,
            "--run",
            &id,
            "--fps",
            "12",
        ]);
    }
    let run = wait_frames(&id);
    let frames = run["frames"].as_array().unwrap();
    assert!(!frames.is_empty(), "animation produced no frames");
    let last = frames
        .iter()
        .map(|f| f["frame_number"].as_i64().unwrap())
        .max()
        .unwrap();
    let start_frame = 2.min(last);
    let end_frame = (last - 1).max(start_frame);

    // Save a sub-range.
    let saved = run_json(&[
        "saved",
        "save",
        "--project",
        &project,
        "--generation-id",
        &id,
        "--start-frame",
        &start_frame.to_string(),
        "--end-frame",
        &end_frame.to_string(),
        "--name",
        "CLI Sword Raise",
    ]);
    assert_eq!(saved["start_frame"].as_i64().unwrap(), start_frame);
    assert_eq!(saved["end_frame"].as_i64().unwrap(), end_frame);
    let saved_id = saved["id"].as_str().unwrap().to_string();

    // Naming, metadata, labels.
    let renamed = run_json(&["saved", "rename", &saved_id, "CLI Sword Raise (named)"]);
    assert_eq!(renamed["name"], "CLI Sword Raise (named)");
    let tagged = run_json(&[
        "saved",
        "metadata",
        &saved_id,
        "--metadata",
        "filepath=/foo/bar/animations/sword-raise.aseprite",
    ]);
    assert_eq!(
        tagged["metadata"]["filepath"],
        "/foo/bar/animations/sword-raise.aseprite"
    );
    let merged = run_json(&[
        "saved",
        "metadata",
        &saved_id,
        "--metadata",
        "variant=background",
    ]);
    assert_eq!(
        merged["metadata"]["filepath"],
        "/foo/bar/animations/sword-raise.aseprite"
    );
    let cleared = run_json(&[
        "saved", "metadata", &saved_id, "--remove", "variant", "--remove", "filepath",
    ]);
    assert!(cleared["metadata"].as_object().unwrap().is_empty());
    // Re-apply the filepath for browsing.
    run_json(&[
        "saved",
        "metadata",
        &saved_id,
        "--metadata",
        "filepath=/foo/bar/animations/sword-raise.aseprite",
    ]);
    let label = label_id(&project, "anim");
    let labels = run_json(&["label", "list", "--project", &project]);
    let label_name = labels["labels"]
        .as_array()
        .unwrap()
        .iter()
        .find(|l| l["id"].as_str() == Some(label.as_str()))
        .map(|l| l["name"].as_str().unwrap().to_string())
        .unwrap();
    run_json(&[
        "label",
        "associate",
        "--saved-animation",
        &saved_id,
        "--name",
        &label_name,
    ]);

    // Archive / unarchive.
    let archived = run_json(&["saved", "archive", &saved_id]);
    assert!(archived["archived_at"].is_string());
    run_json(&["saved", "unarchive", &saved_id]);

    // Frame content by number.
    let dir = temp_dir();
    let frame_path = dir.join("frame.png");
    common::run_ok(&[
        "animation",
        "frames",
        "content-by-number",
        "--run",
        &id,
        "--number",
        &start_frame.to_string(),
        "--output",
        frame_path.to_str().unwrap(),
    ]);
    assert!(std::fs::metadata(&frame_path).unwrap().len() > 0);

    // Export every format.
    for format in [
        "texturepacker",
        "texturepacker.zip",
        "aseprite",
        "godot",
        "godot.zip",
        "grid",
        "gamemaker",
        "sequence.zip",
    ] {
        let path = dir.join(format!("export-{format}"));
        common::run_ok(&[
            "animation",
            "export",
            &id,
            "--format",
            format,
            "--start-frame",
            &start_frame.to_string(),
            "--end-frame",
            &end_frame.to_string(),
            "--output",
            path.to_str().unwrap(),
        ]);
        assert!(
            std::fs::metadata(&path).unwrap().len() > 0,
            "export {format} was empty"
        );
    }

    finish_project(&slug);
}