docs: clarify PFS/PFSC image and container workflows in README #71

2026-06-06T19:24:17-05:00

RenanGBarreto commented

2026-06-06 19:24:17 -05:00

(Migrated from github.com)

Summary

This PR improves the PFS-related documentation in README.md.

What changed

Clarifies the difference between direct PFS images (.ffpfs) and PFSC nested-image containers (.ffpfsc)
Improves the support table wording for both formats
Clarifies that pfs_image.dat is treated as a nested PFS image only when located inside a mounted PFSC container
Cleans up wording in the compressed PFS sections, including a small grammar fixes

Why

The previous README text made the direct PFS and PFSC container flows easy to confuse, especially in the packing examples. These updates make the intended layouts and usage clearer and align the docs with the current implementation.

Scope

Documentation only. No code behavior changes.

Summary by CodeRabbit

Documentation
- Updated docs with experimental compressed-PFS image support and streamlined intro text.
- Expanded supported image table to clearly list .ffpfs (direct) and .ffpfsc (nested-container) options.
- Clarified container layout and mounting rules for nested vs outer images, and signature/cache behavior.
- Rewrote packing guidance with recommended exFAT -> .ffpfsc workflow and an alternate folder->image packing option.

## Summary This PR improves the PFS-related documentation in `README.md`. ### What changed - Clarifies the difference between direct PFS images (`.ffpfs`) and PFSC nested-image containers (`.ffpfsc`) - Improves the support table wording for both formats - Clarifies that `pfs_image.dat` is treated as a nested PFS image only when located inside a mounted PFSC container - Cleans up wording in the compressed PFS sections, including a small grammar fixes ### Why The previous README text made the direct PFS and PFSC container flows easy to confuse, especially in the packing examples. These updates make the intended layouts and usage clearer and align the docs with the current implementation. ## Scope Documentation only. No code behavior changes.  ## Summary by CodeRabbit * **Documentation** * Updated docs with experimental compressed-PFS image support and streamlined intro text. * Expanded supported image table to clearly list .ffpfs (direct) and .ffpfsc (nested-container) options. * Clarified container layout and mounting rules for nested vs outer images, and signature/cache behavior. * Rewrote packing guidance with recommended exFAT -> .ffpfsc workflow and an alternate folder->image packing option.

coderabbitai[bot] commented

2026-06-06 19:24:28 -05:00

(Migrated from github.com)

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 678543d4-8279-4e40-aac6-f3211d2a1bb8

📥 Commits

Reviewing files that changed from the base of the PR and between 2bd8b75566 and 53e266d446.

📒 Files selected for processing (1)

README.md

🚧 Files skipped from review as they are similar to previous changes (1)

README.md

📝 Walkthrough

Walkthrough

This PR revises the README to consolidate the intro, clarify support for experimental compressed PFS formats .ffpfs and .ffpfsc, explain nested-container behavior, and add mkpfs-based packing workflows for exFAT→.ffpfsc, folder→pfs_image.dat→.ffpfsc, and experimental .ffpfs one-pass packing.

Changes

Compressed PFS Format Documentation

Layer / File(s)	Summary
Format support and recommendation `README.md`	Consolidates the README intro; updates the “Current image support” table with clarified `.ffpfs` and `.ffpfsc` rows; adds guidance recommending experimentation with `.ffpfsc` and preferring nested exFAT layout.
PFSC container behavior & packing workflows `README.md`	Clarifies when a nested `pfs_image.dat` is treated as a PFS image inside `.ffpfsc` and how outer vs inner `img_type` apply; replaces compressed-PFS packing docs with `mkpfs` exFAT→`.ffpfsc` commands, adds folder→`pfs_image.dat`→`.ffpfsc` workflow, and documents experimental direct `.ffpfs` one-pass packing example.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through lines of README prose,

New formats named where the compressed wind blows.
exFAT nests snug in .ffpfsc's care,
mkpfs packs tidy in a single dare.
Docs refreshed — the rabbit gives a cheer!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: clarifying PFS/PFSC image and container workflows in README documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/drakmor/ShadowMountPlus/pull/71?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)  No actionable comments were generated in the recent review. 🎉 <details> <summary>ℹ️ Recent review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro Plus **Run ID**: `678543d4-8279-4e40-aac6-f3211d2a1bb8` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 2bd8b755668ef4bc916ba0cbea8312eb4937e0ab and 53e266d446a5070ccfde1cb35a457a27b4096c07. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * README.md </details> </details> ---  <details> <summary>📝 Walkthrough</summary> ## Walkthrough This PR revises the README to consolidate the intro, clarify support for experimental compressed PFS formats `.ffpfs` and `.ffpfsc`, explain nested-container behavior, and add `mkpfs`-based packing workflows for exFAT→`.ffpfsc`, folder→`pfs_image.dat`→`.ffpfsc`, and experimental `.ffpfs` one-pass packing. ## Changes **Compressed PFS Format Documentation** |Layer / File(s)|Summary| |---|---| |**Format support and recommendation** `README.md`|Consolidates the README intro; updates the “Current image support” table with clarified `.ffpfs` and `.ffpfsc` rows; adds guidance recommending experimentation with `.ffpfsc` and preferring nested exFAT layout.| |**PFSC container behavior & packing workflows** `README.md`|Clarifies when a nested `pfs_image.dat` is treated as a PFS image inside `.ffpfsc` and how outer vs inner `img_type` apply; replaces compressed-PFS packing docs with `mkpfs` exFAT→`.ffpfsc` commands, adds folder→`pfs_image.dat`→`.ffpfsc` workflow, and documents experimental direct `.ffpfs` one-pass packing example.| ## Estimated code review effort 🎯 3 (Moderate) | ⏱️ ~20 minutes ## Poem > 🐰 I hopped through lines of README prose, > > New formats named where the compressed wind blows. > > exFAT nests snug in `.ffpfsc`'s care, > > `mkpfs` packs tidy in a single dare. > > Docs refreshed — the rabbit gives a cheer! </details>   <details> <summary>🚥 Pre-merge checks | ✅ 5</summary> <details> <summary>✅ Passed checks (5 passed)</summary> | Check name | Status | Explanation | | :------------------------: | :------- | :------------------------------------------------------------------------------------------------------------------------------------- | | Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. | | Title check | ✅ Passed | The title clearly and concisely summarizes the main change: clarifying PFS/PFSC image and container workflows in README documentation. | | Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. | | Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. | | Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. | </details> ✏️ Tip: You can configure your own custom pre-merge checks in the settings. </details>   <details> <summary>✨ Finishing Touches</summary> <details> <summary>🧪 Generate unit tests (beta)</summary> - [ ]  Create PR with unit tests </details> </details>   --- Thanks for using [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=drakmor/ShadowMountPlus&utm_content=71)! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> Comment `@coderabbitai help` to get the list of available commands and usage tips.

copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed

2026-06-06 19:24:51 -05:00

copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the README to clarify ShadowMountPlus image-type semantics and to expand/modernize documentation around compressed PFS workflows (especially .ffpfsc and .ffpfs).

Changes:

Refines the “Current image support” table descriptions for .ffpfs / .ffpfsc.
Reworks the “Compressed PFS” docs to focus on recommended exFAT→PFSC packing and adds new .ffpfs (direct) guidance.
Adjusts wording around PFSC container layout requirements and headings.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Pull request overview > [!NOTE] > Copilot was unable to run its full agentic suite in this review. Updates the README to clarify ShadowMountPlus image-type semantics and to expand/modernize documentation around compressed PFS workflows (especially `.ffpfsc` and `.ffpfs`). **Changes:** - Refines the “Current image support” table descriptions for `.ffpfs` / `.ffpfsc`. - Reworks the “Compressed PFS” docs to focus on recommended exFAT→PFSC packing and adds new `.ffpfs` (direct) guidance. - Adjusts wording around PFSC container layout requirements and headings. --- 💡 <a href="/drakmor/ShadowMountPlus/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

README.md

					
				@ -243,20 +216,60 @@ make_image.bat "C:\images\PPSA12345.exfat" "C:\payload\PPSA12345-app"

				The exFAT image must contain the game files at the image root, without an extra

The section title calls .ffpfs “Folders”, but the section body describes it as a direct compressed PFS image format. Renaming the heading to match the terminology used elsewhere (e.g., “Direct compressed PFS images (.ffpfs)” or “Compressed PFS images (.ffpfs)”) would reduce ambiguity.

The section title calls `.ffpfs` “Folders”, but the section body describes it as a direct compressed PFS image format. Renaming the heading to match the terminology used elsewhere (e.g., “Direct compressed PFS images (`.ffpfs`)” or “Compressed PFS images (`.ffpfs`)”) would reduce ambiguity.

Earlier examples used explicit options like --verify, --version PS5, and --inode-bits 32, but the updated commands omit them. If these flags are still required/recommended for PS5 images, the README should either include them here as well or state that the current mkpfs defaults are equivalent; otherwise readers may end up producing images with different parameters than intended.

Earlier examples used explicit options like `--verify`, `--version PS5`, and `--inode-bits 32`, but the updated commands omit them. If these flags are still required/recommended for PS5 images, the README should either include them here as well or state that the current `mkpfs` defaults are equivalent; otherwise readers may end up producing images with different parameters than intended.

README.md

The text says the output is a .ffpfsc container, but the example command produces ./PPSA12345.exfat.ffpfsc (double extension). This is likely to confuse users and also conflicts with earlier examples that imply PPSA12345.ffpfsc. Consider updating the output filename to ./PPSA12345.ffpfsc (or explicitly stating why the double extension is recommended). Also remove the trailing space at the end of the comment line to avoid markdown/style noise.

The text says the output is a `.ffpfsc` container, but the example command produces `./PPSA12345.exfat.ffpfsc` (double extension). This is likely to confuse users and also conflicts with earlier examples that imply `PPSA12345.ffpfsc`. Consider updating the output filename to `./PPSA12345.ffpfsc` (or explicitly stating why the double extension is recommended). Also remove the trailing space at the end of the comment line to avoid markdown/style noise.

RenanGBarreto (Migrated from github.com) reviewed

2026-06-07 13:58:13 -05:00

README.md

					
				@ -243,20 +216,60 @@ make_image.bat "C:\images\PPSA12345.exfat" "C:\payload\PPSA12345-app"

				The exFAT image must contain the game files at the image root, without an extra

Defaults are already made with the correct flags.

RenanGBarreto (Migrated from github.com) reviewed

2026-06-07 13:58:29 -05:00

README.md

					
				@ -243,20 +216,60 @@ make_image.bat "C:\images\PPSA12345.exfat" "C:\payload\PPSA12345-app"

				The exFAT image must contain the game files at the image root, without an extra

Solved

RenanGBarreto (Migrated from github.com) reviewed

2026-06-07 13:58:38 -05:00

README.md

Solved

This pull request is broken due to missing fork information.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin 'unknown repository:unknown repository'

git switch 'unknown repository'

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch 'main'

git merge --no-ff 'unknown repository'

git switch 'unknown repository'

git rebase 'main'

git switch 'main'

git merge --ff-only 'unknown repository'

git switch 'unknown repository'

git rebase 'main'

git switch 'main'

git merge --no-ff 'unknown repository'

git switch 'main'

git merge --squash 'unknown repository'

git switch 'main'

git merge --ff-only 'unknown repository'

git switch 'main'

git merge 'unknown repository'

git push origin 'main'

Sign in to join this conversation.

No reviewers

No labels

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-drakmor/ShadowMountPlus!71

				`@ -243,20 +216,60 @@ make_image.bat "C:\images\PPSA12345.exfat" "C:\payload\PPSA12345-app"`
				`The exFAT image must contain the game files at the image root, without an extra`

Rows
Columns