NdsForge.NdsImageBuildOptions Class Reference

Controls deterministic physical placement without mixing Layout policy into image metadata. More...

Properties
static NdsImageBuildOptions	Default = new() [get]
	Uses a 16 KiB header area, 512-byte component boundaries, four-byte file boundaries, and verification.
NdsImageBuildProfile	Profile [get]
	Selects NdsForge defaults or a precisely versioned external-tool Layout contract.
int	HeaderSize = 0x4000 [get]
	Reserves bytes before the first Program; DS homebrew conventionally uses 0x4000.
int	SectionAlignment = 0x200 [get]
	Aligns Programs, filesystem tables, and Banner starts; it must be a positive power of two.
int	FileAlignment = 4 [get]
	Aligns individual FAT payload starts; four bytes avoids unnecessary growth while retaining word alignment.
byte	PaddingByte = 0xFF [get]
	Fills every Layout gap after the reserved header area, making otherwise unspecified bytes reproducible.
bool	VerifyOutput = true [get]
	Reopens the completed stream and validates its structure, checksums, and NitroFS payload mapping.
bool	OverwriteDestination [get]
	Allows a successful path build to atomically replace an existing regular destination file.

Detailed Description

Controls deterministic physical placement without mixing Layout policy into image metadata.

Definition at line 4 of file NdsImageBuildOptions.cs.

Property Documentation

Default

NdsImageBuildOptions NdsForge.NdsImageBuildOptions.Default = new()

staticget

Uses a 16 KiB header area, 512-byte component boundaries, four-byte file boundaries, and verification.

Definition at line 7 of file NdsImageBuildOptions.cs.

FileAlignment

int NdsForge.NdsImageBuildOptions.FileAlignment = 4

get

Aligns individual FAT payload starts; four bytes avoids unnecessary growth while retaining word alignment.

Definition at line 19 of file NdsImageBuildOptions.cs.

HeaderSize

int NdsForge.NdsImageBuildOptions.HeaderSize = 0x4000

get

Reserves bytes before the first Program; DS homebrew conventionally uses 0x4000.

Definition at line 13 of file NdsImageBuildOptions.cs.

OverwriteDestination

bool NdsForge.NdsImageBuildOptions.OverwriteDestination

get

Allows a successful path build to atomically replace an existing regular destination file.

Definition at line 28 of file NdsImageBuildOptions.cs.

PaddingByte

byte NdsForge.NdsImageBuildOptions.PaddingByte = 0xFF

get

Fills every Layout gap after the reserved header area, making otherwise unspecified bytes reproducible.

Definition at line 22 of file NdsImageBuildOptions.cs.

Profile

NdsImageBuildProfile NdsForge.NdsImageBuildOptions.Profile

get

Selects NdsForge defaults or a precisely versioned external-tool Layout contract.

Definition at line 10 of file NdsImageBuildOptions.cs.

SectionAlignment

int NdsForge.NdsImageBuildOptions.SectionAlignment = 0x200

get

Aligns Programs, filesystem tables, and Banner starts; it must be a positive power of two.

Definition at line 16 of file NdsImageBuildOptions.cs.

VerifyOutput

bool NdsForge.NdsImageBuildOptions.VerifyOutput = true

get

Reopens the completed stream and validates its structure, checksums, and NitroFS payload mapping.

Definition at line 25 of file NdsImageBuildOptions.cs.

---

The documentation for this class was generated from the following file:

• src/NdsForge/Building/NdsImageBuildOptions.cs