This repository documents a two-layer Virtual FileSystem (VFS) architecture for game modding. The VFS allows games to see and access files that don't physically exist in the game folder, enabling non-invasive modding without administrator rights or filesystem modifications.
Layer 1 (Virtual FileSystem) handles path redirection and makes virtual files visible in directory listings by hooking OS file APIs (primarily
ntdll.dll
on Windows).
Layer 2 (Virtual File Framework) synthesizes file content on-the-fly when virtual files are read, providing an abstraction for extensions.
Layer 3 (Extensions) are plugins like Archive Emulation Framework and Nx2VFS that build on Layers 1 & 2.
The
docs/
folder contains MkDocs documentation. The
examples/
folder contains Rust demonstration code showcasing VFS-related techniques (DirectStorage, memory mapping, PE patching).
Use British English spelling throughout all documentation, code comments, and error messages.
mkdocs build --strict
— Build documentation and check for errors- Before running mkdocs, create/use a virtual environment like
start_docs.py
does
- NEVER run blocking commands like
mkdocs serve
or start_docs.py
- The
examples/
folder contains a Cargo workspace with Rust demonstration code
- Visuals with captions: Use
.avif
where visuals add clarity; include a caption
- Link hygiene: Prefer relative links for internal docs; link to official tool docs externally
- Admonitions for emphasis: Use
tip
, info
, warning
, example
, and collapsible ???
blocks
- Prefer
.avif
images with descriptive alt text and captions
- Include visuals when they clarify outcomes; skip them for configuration pages if not valuable
Caption format:
/// caption
Clear explanation of what's shown and why it matters
///
Use for emphasis and scannability:
!!! tip "Best Practice"
Helpful hint for optimal usage.
!!! info "Additional Context"
Extra useful information.
!!! warning "Important Note"
Critical information.
!!! example "Real World Use"
Practical example.
??? info "Advanced Details"
Collapsible technical details.
Inline and list annotations are allowed:
Text with annotation (1)
{ .annotate }
1. This is the annotation content.
For lists:
<div class="annotate" markdown>
1. item one (1)
2. item two
</div>
1. annotation for item one
Always specify language for syntax highlighting:
```bash
cargo bench
```
```rust
fn example() {}
```
docs/
markdown files follow mkdocs.yml
navigation structureexamples/
is a Cargo workspace; each example is a separate package