Skip to content

Conversation

@Minty123
Copy link
Contributor

@Minty123 Minty123 commented Jan 1, 2026

Since we can now control the game's USM files and update them with custom ones, I added a new page to the docs with an overview of all USMs in the game.

Summary by CodeRabbit

  • Documentation
    • Added a detailed guide on the USM (CriMovie) video container used in Kingdom Hearts III, covering format overview, asset organization, language variants, directory mappings, and illustrative references.
    • Updated the KH3 documentation index to include a link to the new USM (CriMovie) guide.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 1, 2026

📝 Walkthrough

Walkthrough

Adds a new documentation page describing USM (CriMovie) usage and file layout for Kingdom Hearts III and updates the KH3 docs index to link to it.

Changes

Cohort / File(s) Summary
New Documentation
docs/kh3/crimovie.md
Adds a read-only guide describing the USM/CriMovie container: video/audio/alpha overview, encrypted H264/MPEG and HCA audio notes, base paths, structured file lists with language variants, folder/file tables, world associations, and external YouTube references.
Documentation Index
docs/kh3/index.md
Adds an "USM Files (CriMovie)" entry under the "Other" section linking to the new crimovie.md page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through folders, frames, and lore,

Found USM whispers on the KH3 shore,
Crimovie maps and lists in tidy rows,
World clips, day1 files, and playback flows,
A rabbit's note where cinematic river goes.

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding documentation for USM files in Kingdom Hearts 3, which aligns with the PR's objective of providing an overview of all USMs in KH3.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ddf2fe and 2a945be.

📒 Files selected for processing (1)
  • docs/kh3/crimovie.md
🧰 Additional context used
🪛 LanguageTool
docs/kh3/crimovie.md

[grammar] ~24-~24: Ensure spelling is correct
Context: ...x | Japanese (for Asian Market) | ### day1 To prevent pre-release leaks of the epil...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: build
🔇 Additional comments (1)
docs/kh3/crimovie.md (1)

1-160: Well-structured documentation with previous issues resolved.

The document looks solid overall. The format description is clear, the file tables are comprehensive and consistently formatted, and all previously flagged issues—the link text descriptiveness (line 12), the empty link (line 49), and the duplicate word (line 42)—have been properly addressed. The language code variants (en, ja, jax) are clearly documented, and the YouTube references provide good context for each asset.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fb4d70 and 619c7b2.

📒 Files selected for processing (2)
  • docs/kh3/crimovie.md
  • docs/kh3/index.md
🧰 Additional context used
🪛 LanguageTool
docs/kh3/crimovie.md

[grammar] ~23-~23: Ensure spelling is correct
Context: ...x | Japanese (for Asian Market) | ### day1 To prevent pre-release leaks of the epil...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~25-~25: Ensure spelling is correct
Context: ... of the epilogue and secret ending, the day1 files were originally shipped in a sepa...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
docs/kh3/crimovie.md

6-6: Link text should be descriptive

(MD059, descriptive-link-text)


48-48: No empty links

(MD042, no-empty-links)

docs/kh3/index.md

11-11: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (1)
docs/kh3/crimovie.md (1)

1-159: LGTM on documentation structure and comprehensiveness.

The new USM documentation is well-organized with clear sections for format overview, language variants, and comprehensive file listings with cross-references to video content. The tables are properly structured, and file-to-world mappings provide valuable context. Once the minor linting issues (link descriptiveness and empty link) are resolved, this documentation will be a valuable addition to the KH3 reference material.

- Adjusted link text to comply with MD059
- Removed empty link
@Minty123
Copy link
Contributor Author

Minty123 commented Jan 1, 2026

Took care of CodeRabbit's suggestions. That was actually quite helpful.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 619c7b2 and 7ddf2fe.

📒 Files selected for processing (2)
  • docs/kh3/crimovie.md
  • docs/kh3/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/kh3/index.md
🧰 Additional context used
🪛 LanguageTool
docs/kh3/crimovie.md

[grammar] ~24-~24: Ensure spelling is correct
Context: ...x | Japanese (for Asian Market) | ### day1 To prevent pre-release leaks of the epil...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: build
🔇 Additional comments (2)
docs/kh3/crimovie.md (2)

12-12: ✓ Descriptive link text is now in place.

The previous review flagged the use of "here" as non-descriptive link text. The current version now uses "[Criware's USM format Part 1]" which clearly indicates what the resource is about. Good fix!


49-49: ✓ Empty link issue resolved.

The previous review flagged an empty link on this line. It's now been converted to plain text "Timelapse of Clouds in Tutorial Section" with no broken link syntax. Good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant