Skip to content

README: install, update, and what to do after opening a project - #152

Merged
GhzGarage merged 1 commit into
mainfrom
docs/readme-getting-started
Nov 11, 2026
Merged

GhzGarage merged 1 commit into
mainfrom
docs/readme-getting-started

Conversation

@GhzGarage

Copy link
Copy Markdown
Contributor

Rewrites the README. The old one only said to put the folder in Engine/Plugins.

What it covers now

  • What you need: UE 5.8, the Mantle game for Test Locally and creator tokens, and a Mantle account.
  • Installing from Fab (Install to Engine), and turning the plugin on with Edit → Plugins.
  • Updating: install again from Fab Library.
  • What the release source zips are, and why a Launcher engine needs Fab instead.
  • After you open a project:
    1. Find the tools.
    2. Start a new place.
    3. Test Locally.
    4. Check this place / Check what players receive.
    5. Sign in with a creator token, then Save to Mantle or Publish.
  • The other tools (vehicle, weapon, Cosmetics, Library, Voxelize, Mantle Scripts), with links into the creator docs.

How I checked it

  • Menu names, button names and tooltips match MantleEditor.cpp (FillMantleSection, RegisterMenus), MantleScriptsPanelController.cpp and MantleSettings.h.
  • The install steps and links match the website's plugin page and quick start (mantle-site/content/docs/creators/plugin.html, quick-start.html).

Docs only. No code changes.

🤖 Generated with Claude Code

Requirements, installing from Fab, updating, what the source zips are for, and
a first-place walkthrough: where the tools are, Start a new place, Test
Locally, the checks, signing in with a creator token, Save to Mantle and
Publish. Ends with the other tools and links to the creator docs. Menu names
and steps match the editor's own menus (MantleEditor.cpp) and the website's
plugin page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@GhzGarage
GhzGarage merged commit 07abe22 into main Nov 11, 2026
1 check passed
@GhzGarage
GhzGarage deleted the docs/readme-getting-started branch November 11, 2026 01:55
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