Docs · v1.2.6
How to use the assistant.
Short pages. One page per task. Two clicks max to anything you need.
Quick start
From install to your first audit.
- 01
Install
Download the Windows installer and run it. PerfectPolaris installs in seconds as a standalone app: no Unreal plugin, and no Python to set up. Everything it needs is bundled.
- 02
Pair your account
On first launch a short wizard walks you through it. PerfectPolaris shows a pairing code; sign in on the connect page, type the code in, and approve. It is free to download; once you are signed in you can sample the read-only audits, and a subscription unlocks the full toolset.
- 03
Connect your Unreal project
Open the Connection tab in the configure page and point PerfectPolaris at your project's
.uproject. It switches on Python remote execution for you, so there is no settings page to hunt through. Restart the editor once (Unreal reads the setting at startup) and the two are talking. - 04
Run your first audit
Pick an audit from the left panel. Three are free on any account: lighting, textures, and naming. The wider audit set — materials, collisions, and more — needs a subscription. Audits are read-only, so they run without changing anything. Issues come back sorted by fix-cost, with the flagged assets gathered into a Content Browser collection.
- 05
Apply a fix
Every fix previews as a dry run first. Read what would change, then press Apply to commit it. Nothing writes to your project until you approve it.
- 06
Set your conventions
Open the configure page (the gear icon at the top of the tools panel) to set naming prefixes, texture rules, audit scope, and mesh and material norms per project. Your rules are what the audits check against.
Can't find what you're looking for?
Email me at Polaris@PerfectPolys.com and I'll either point you at it or write the page.