Skip to content

Add player guides for portable profiles, modpacks and Manage Worlds - #762

Merged
Zaldaryon merged 2 commits into
devfrom
docs/beta14-guides
Oct 17, 2026
Merged

Zaldaryon merged 2 commits into
devfrom
docs/beta14-guides

Conversation

@Pixnop

@Pixnop Pixnop commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Three player guides, docs only.

  • New: Portable profile (docs/get-started/usage/portable-profile.md), covering the RiftLauncher.portable marker, what the first portable start copies, what stays where it is, and how to go back.
  • New: Modpacks (docs/get-started/usage/game-client/modpacks.md).
  • Rewritten: Manage Worlds (docs/get-started/usage/game-client/worlds.md).
  • docs/SUMMARY.md lists the two new pages.

What was checked and how:

  • The Windows steps of the portable guide match the manual Windows pass on beta.14: a portable profile with the marker beside the install folder, the RiftLauncherData folder, the Config page showing it, and the refusal of a junction.
  • Going back was run headless on Linux with the released 1.7.0-beta.14 AppImage and throwaway profile folders. With the marker beside the AppImage, the first start copied the profile into RiftLauncherData and the Config page showed that folder. After deleting the marker, the next start used the profile in the user folder again, and RiftLauncherData was left beside the AppImage unchanged, nothing copied back and nothing deleted. The guide now says exactly that.
  • npx prettier --check docs passes, and the relative links in the changed pages and SUMMARY.md resolve. The repo has no docs link checker.

The documentation site picks these pages up from dev at its next build.

Issue #635 lists three website guides to write before 1.7.0. The site
renders docs/ from dev, so they live here.

Portable profile is a new page under Usage: turning it on with the
marker on Windows and on the AppImage, what the first start copies,
what stays where it is, logins on another computer, where updates
download, and going back. The installation pages keep the detail.

Share a modpack is a new page beside Install/Manage Mods. Modpack
export and import had no page at all; it covers servers and the mod
config picker from #572, the import defaults, and where a replaced
config is kept.

Manage worlds is rewritten as steps a player follows, keeping the
explanation of the -wal and -shm files from #693.

Two comments marked VERIFY sit in the portable page, for the manual
Windows pass and for going back, which nobody has run by hand yet.
The Windows steps match the manual Windows pass on beta.14. Going back was run headless on Linux with the released AppImage: without the marker the next start uses the profile in the user folder, and RiftLauncherData is left beside the AppImage unchanged.

@Zaldaryon Zaldaryon left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Tested on head 9e11947. Documentation formatting verified via npm run format:check, and relative links and page structure in SUMMARY.md resolve properly. The descriptions of portable profile behaviour, modpack safety, and SQLite file locks accurately reflect launcher mechanics. Approving.

@Zaldaryon
Zaldaryon merged commit d96c0ec into dev Oct 17, 2026
12 checks passed
@Zaldaryon
Zaldaryon deleted the docs/beta14-guides branch October 17, 2026 13:48
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.

2 participants