Added a simple example for the set path

[mads-gregersen]

Just added an example for the set_path command

Summary by CodeRabbit

• Documentation
  • Clarified manual path setup: instruct users not to surround paths with quotation marks and added a concrete example Windows path to follow.
  • Clarified save-file guidance for scripted runs: noted that an existing save can be reused but recommend creating a new save per run and warned about potential issues when reusing the same save across multiple runs.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR updates Sims 4 Archipelago setup docs: clarifies manual path entry (do not include quotes), adds a Windows example path, and advises that an existing save can be used but recommends a fresh save per run, noting potential issues when reusing the same save.

Changes

Cohort / File(s)	Summary
Documentation updates worlds/sims4/docs/setup_en.md	Clarified not to include quotes when manually setting the path, added an example Windows path for manual set_path, and added guidance that an existing save may be used but a fresh save per run is recommended due to potential reuse issues.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Paths neat as carrot dew,
No quotes stuck—just clear and true,
A fresh save hops in for play,
One run, one save, and joy that stays.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is minimal and does not follow the repository's template structure, missing required sections like 'What is this fixing or adding?' and testing information.	Expand the description to follow the template format, including specific details about what was added (guidance on quotes, Windows path example, save file notes) and how it was tested.
Title check	❓ Inconclusive	The title 'Added a simple example for the set path' is vague and generic, lacking clarity about which file or section was modified.	Consider using a more specific title like 'Docs: add set_path example with Windows path guidance' to clearly indicate this is documentation and what specifically was added.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5aa5411 and df83311.

📒 Files selected for processing (1)

• worlds/sims4/docs/setup_en.md

🔇 Additional comments (3)

worlds/sims4/docs/setup_en.md (3)

27-27: ✅ Typo fixed.

The contraction "don't" is now correctly used, addressing the prior review comment.

---

28-28: Partial resolution of platform clarification.

The "(Windows)" label was added as suggested in the prior review. However, the previous comment also recommended providing equivalent example paths for macOS and Linux (given that the documentation earlier mentions these platform differences at line 15). Consider adding platform-specific path examples for consistency and to help users on other platforms quickly find the correct format.

Example additions could include:

• macOS: /set_path /Users/username/Documents/Electronic Arts/The Sims 4/Mods
• Linux: /set_path /home/username/.local/share/The Sims 4/Mods

---

32-33: ✅ New save file guidance is clear and helpful.

The addition properly explains the recommendation for fresh save files per run, provides the reasoning, and transparently acknowledges known issues with save reuse. The guidance is well-integrated into the setup flow.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In @worlds/sims4/docs/setup_en.md:
- Line 27: Replace the typo "dont" with the contraction "don't" in the sentence
"If you have to manually set the path make sure you dont include quotes in the
path" (edit that exact sentence in worlds/sims4/docs/setup_en.md so it reads "If
you have to manually set the path make sure you don't include quotes in the
path").
- Line 28: Clarify that the provided example path "/set_path
C:/Users/User/Documents/Electronic Arts/The Sims 4/Mods" is Windows-specific by
appending a platform label (e.g., "(Windows)") and/or add equivalent example
paths for macOS and Linux (e.g., a macOS example like "/set_path
/Users/username/Documents/Electronic Arts/The Sims 4/Mods" and a Linux example
like "/set_path /home/username/.local/share/The Sims 4/Mods") so readers on
other platforms immediately see the correct format.

📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 966b69f and 8979cb3.

📒 Files selected for processing (1)

• worlds/sims4/docs/setup_en.md

🔇 Additional comments (1)

worlds/sims4/docs/setup_en.md (1)

32-33: Good addition to script mods guidance.

The clarification about using a fresh save for each run and the note about potential issues with save reuse is helpful and well-integrated. This provides users with practical recommendations to avoid frustration.

[benny-dreamly]

Are you in the main Archipelago discord server? I don't think I've seen you around before, but that's not an issue.

How did you find this project?

[benny-dreamly]

If you're able, could you consider adding an example path to the client as well? It'd be under _cmd_set_path for the command itself.

I believe editing the docstring on that function is sufficient, however I'd have to get back to you on that.

[benny-dreamly]

I also fixed a couple of things code rabbit pointed out, but honestly I don't know if I want it to review docs or not, so I might change the settings a bit.