-
Notifications
You must be signed in to change notification settings - Fork 0
Glossary
Definitions of terms used throughout the documentation and the source code.
Bug report
A diagnostic document containing environment details, the error message, and exception details,
written to error.log and optionally submitted to the developer API. See Services.
Dokan A Windows user-mode file system framework and kernel driver that lets applications expose virtual file systems without writing a kernel driver. SimpleXisoDrive uses Dokan 2.x. See https://github.com/dokan-dev/dokany.
DokanNet
The .NET wrapper around the Dokan library. The IDokanOperations interface implemented by
XboxIsoVfsDokan comes from this library.
Drive letter mount
Mapping a volume to a letter such as Z:. Requires a free letter and is most reliable with
administrator rights.
Entry size The total number of bytes occupied by a directory entry on disk, including the 14-byte header, the name, and padding to a 4-byte boundary.
FILETIME A Windows timestamp format representing 100-nanosecond intervals since 1601-01-01 UTC. The XDVDFS volume descriptor stores the volume creation time as a FILETIME.
FileEntry The in-memory representation of one XDVDFS directory entry: child pointers, data location, size, attributes, and name. See XDVDFS Format.
GLOBAL partition
One of the supported disc layout offsets (0x0FD90000) at which the volume descriptor may be found
on certain releases.
IsoSt The stream abstraction over the ISO file. It applies the volume offset, serializes access with a lock, and reads sectors and directory entries.
Iteration limit A safety cap of 100,000 nodes per directory tree traversal, used to abort on corrupted or circular trees.
Magic ID
The signature MICROSOFT*XBOX*MEDIA stored twice in the volume descriptor. Both copies must match
for the descriptor to be valid.
Mount point
The location where the image becomes visible: a drive letter (Z:) or an NTFS folder path.
NTFS folder mount Mapping a volume into an existing directory on an NTFS volume. Does not consume a drive letter.
Partition offset
The byte offset within the image at which the game partition (and therefore the volume descriptor)
begins. SimpleXisoDrive sets IsoSt.VolumeOffset to the offset of the winning descriptor location.
Read-only volume A volume on which all mutating operations are rejected. SimpleXisoDrive mounts every image this way.
Redump-style image A raw disc dump format that may contain additional/encrypted data and is not directly mountable as XDVDFS until converted to XISO.
Root directory table The sector referenced by the volume descriptor from which the entire directory tree is reachable.
Sector The addressing unit for the image: 2048 bytes. File data and directory tables are sector-aligned.
Serilog
The structured logging library used by the application. Console, rolling file, and bug report sinks
are configured in LoggingSetup.
Sink
A Serilog output target. BugReportSink forwards Warning and higher events to the reporting
pipeline.
Subtree index
The 16-bit pointer to a child directory entry, expressed as an index that must be multiplied by 4 to
obtain a byte offset. The value 0xFFFF means "no child".
Volume descriptor The structure that identifies an XDVDFS volume and points to the root directory table. It occupies one sector and contains two magic IDs. See XDVDFS Format.
Volume offset The global byte offset applied to every stream read so the parser can ignore partition padding before the game partition.
VFS (Virtual File System)
The abstraction layer (VfsContainer) that resolves paths, caches entries, and serves file data to
the Dokan operation layer.
XGD1 / XGD3 Xbox Game Disc layout variants. SimpleXisoDrive probes their known partition offsets when looking for a volume descriptor.
XISO Common shorthand for an Xbox disc image in XDVDFS format. "Rebuilt XISO" images place the volume descriptor at sector 0.
XDVDFS Xbox Disc Video File System, the file system used on original Xbox game discs. See XDVDFS Format.
User guide
Technical reference
Development