Skip to content

Commit 57b7bbf

Browse files
committed
(docs) list of agrf_* options for manifest
1 parent 6199cab commit 57b7bbf

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

doc/manifest_json.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# AGRF Manifest Options
2+
3+
Below are extra options you can put in a `gorender` `manifest.md` that will be instead consumed by AGRF, controlling various aspects of rendering behavior.
4+
5+
The current list is AI-generated summary, which is still better than nothing since one sometimes just needs such a list. I will update this list when I have time.
6+
7+
## Sprite Configuration
8+
9+
### `agrf_subset`
10+
- **Type**: Array or special value
11+
- **Description**: Controls which sprites/indices to use from the spritesheet
12+
13+
### `agrf_unnaturalness`
14+
- **Type**: Number
15+
- **Description**: Controls sprite dimension adjustments for non-standard sizes
16+
17+
### `agrf_scale`
18+
- **Type**: Number
19+
- **Description**: Scale factor applied to sprites
20+
21+
### `agrf_scales`
22+
- **Type**: Array of Numbers
23+
- **Description**: List of scale values for sprites
24+
25+
### `agrf_zdiff`
26+
- **Type**: Number
27+
- **Description**: Z-axis offset for sprite positioning
28+
29+
### `agrf_real_x`
30+
- **Type**: Number
31+
- **Description**: Real X dimension (used in road mode calculations)
32+
33+
## Rendering Modes
34+
35+
### `agrf_road_mode`
36+
- **Type**: Boolean
37+
- **Description**: Enable road-specific rendering mode
38+
- **Example**: `"agrf_road_mode": true`
39+
40+
### `agrf_cargo_mode`
41+
- **Type**: Boolean
42+
- **Description**: Enable cargo-specific rendering mode
43+
- **Example**: `"agrf_cargo_mode": true`
44+
45+
## Palette Configuration
46+
47+
### `agrf_palette`
48+
- **Type**: String
49+
- **Description**: Path to palette file for rendering
50+
- **Example**: `"agrf_palette": "path/to/palette.pal"`
51+
52+
## Sprite Positioning and Offsets
53+
54+
### `agrf_deltas`
55+
- **Type**: Array
56+
- **Description**: Delta values for spritesheet positioning
57+
58+
### `agrf_ydeltas`
59+
- **Type**: Array
60+
- **Description**: Y-delta values for spritesheet positioning
61+
62+
### `agrf_offsets`
63+
- **Type**: Array
64+
- **Description**: Offset values for spritesheet positioning
65+
66+
### `agrf_yoffsets`
67+
- **Type**: Array
68+
- **Description**: Y-offset values for spritesheet positioning
69+
70+
### `agrf_bpps`
71+
- **Type**: Array
72+
- **Description**: Bits per pixel values for sprites
73+
74+
### `agrf_bbox_joggle`
75+
- **Type**: Number or Array
76+
- **Description**: Bounding box adjustment
77+
78+
## Child Sprite Configuration
79+
80+
### `agrf_childsprite`
81+
- **Type**: Array or Object
82+
- **Description**: Child sprite configuration for complex objects
83+
84+
### `agrf_relative_childsprite`
85+
- **Type**: Boolean
86+
- **Description**: Use relative positioning for child sprites
87+
- **Example**: `"agrf_relative_childsprite": true`
88+
89+
## Cropping Configuration
90+
91+
### `agrf_manual_crop`
92+
- **Type**: Boolean
93+
- **Description**: Enable manual cropping mode
94+
- **Example**: `"agrf_manual_crop": true`
95+
96+
### `agrf_manual_crop_keep_br_space`
97+
- **Type**: Boolean
98+
- **Description**: Keep bottom-right space when manually cropping
99+
- **Example**: `"agrf_manual_crop_keep_br_space": true`
100+
101+
## Mask Configuration
102+
103+
### `agrf_no_mask`
104+
- **Type**: Boolean
105+
- **Description**: Disable masking for sprites
106+
- **Example**: `"agrf_no_mask": true`

0 commit comments

Comments
 (0)