On this page
Scripts and the Library
Scripts tell Atlas what to look for and what to do with your controller. Write your own in the Script Editor, or get ready-made scripts and model weights from the Atlas Library.
Pre-release documentation: Script Editor and Library guidance for Atlas for Windows 0.1.8. Available actions depend on your account, the item, and current server access checks. Labels and behavior can change before release.
The Script Editor
Select Script Editor in the navigation bar. A new editor starts with Starter Script.atlas, a short example you can change and save.
| To | Use |
|---|---|
| Start a new script | Ctrl+N, or New script tab in the tab strip |
| Open a script | Open Script or Ctrl+O |
| Save | Save or Ctrl+S; Save As or Ctrl+Shift+A; Save All or Ctrl+Shift+S |
| Build and run | Run Script or F5 |
| Rename or close a tab | Right-click the tab. Renaming changes only the tab's name, not the file. |
| Jump to an event or function | The Events and Functions lists above the editor |
| Find the file on disk | Copy Path or Open Folder |
| Read the documentation | Docs opens this site's Atlas Script guide |
Scripts are .atlas files, saved by default in Documents\Atlas\Scripts. Atlas reopens
your last script when it starts. When the window is narrow, buttons that don't fit move to More commands.
As you type, the Problems panel lists errors and warnings with their line numbers. Select a problem and use Quick fix when it is offered, or Copy selected to share it. Each message is explained in Script diagnostics.
Run a script
- Select Start in the main window. Atlas needs a running session before a script can run.
- In the Script Editor, select Run Script or press F5. If the script has never been saved, Atlas asks you to save it first.
- Atlas builds the script. If the build fails, the script does not run, and the session log below the preview in the Vision view shows Script load failed with the line and the reason (select Show logs if the log is hidden).
- When the script is running, Atlas switches to the Vision view so you can watch it work.
- Select Stop Script to stop it. Atlas clears everything the script was setting on your controller.
Learn Atlas Script
- Start with the Atlas Script overview to see how a script runs.
- Select Recipes in the editor for categorized examples, and Copy sample to use one. The same examples are on the Recipes page.
- Look up any event, object or method in the API reference.
The Atlas Library
Select Library in the navigation bar, or Browse Library in the sidebar. Search by name or author, filter by type (Scripts or Weights) and price, and sort by newest, title or price. Select Details to read about an item.
| Button | What it does |
|---|---|
| Add to Editor | Opens an open-source script as a new, unsaved editor tab that you can read, change and save. |
| Select to Run | Selects a protected script. Protected scripts run inside Atlas without their source being shown or saved; the sidebar shows Protected · used inside Atlas. |
| Load in Memory | Loads protected model weights (up to 64 MiB) and shows the atlas-library:// address to use with models.set. See Add a model. |
| Not available in this version or Streaming support required | This version of Atlas for Windows can't use the item yet. |
Select My Library to view your purchased and claimed versions when this account service is available. Atlas verifies access again when you open an item. Eligible scripts offer Select to Run; eligible model weights offer Load in Memory. Items with revoked or unavailable access cannot be opened. Use Refresh to check again, or Try again after an error.
Publish a script
If your account has publisher access, select Publish in the Script Editor to submit the open script to the Library. Choose Open source to share the source, or Compile & protect to share it as a protected script. Scripts published from Atlas for Windows are free.
- The title can be up to 120 characters and the description up to 4,000.
- The script can be up to 1 MiB.
- After you submit, Atlas shows Submitted to Atlas Library with the submission's status, for example
PendingValidation. It appears in the Library once its status isPublished.
Script problems
| What you see | What to do |
|---|---|
| Start CV before running a script | Select Start in the main window first. |
| Script load failed: Line N: … | Fix the problem on that line. Script diagnostics explains each message. |
| Atlas only runs .atlas scripts. Python scripts are not supported. | Atlas runs only Atlas Script, saved with the .atlas extension. |
| Editor unavailable. Your running session is unaffected. | The editor needs the Microsoft Edge WebView2 Runtime. Install or repair it, then restart Atlas. |
| … blocked. Authorization denied for … | Your plan or sign-in does not allow this action right now. See Authorization messages. |