mirror of
https://github.com/github/awesome-copilot.git
synced 2026-05-28 17:41:45 +00:00
John Haugabook
b50617e33e
* resolve readme validate * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: John Haugabook <johnhaugabook@gmail.com> * rhino3d-scripts: rm reference to deprecated VBScript --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
96 lines
2.7 KiB
Markdown
96 lines
2.7 KiB
Markdown
# Macros, Loading, and Running Scripts
|
||
|
||
## Command Macros (no script needed)
|
||
|
||
A macro is a string of command-line input. Anywhere Rhino accepts a command (alias, toolbar button, `_ReadCommandFile`), you can place a macro.
|
||
|
||
### Syntax rules
|
||
|
||
| Token | Meaning |
|
||
|---|---|
|
||
| `!` | **Cancel** any currently running command before this one starts. Always start macros with `!`. |
|
||
| `_` | Use the **English** (invariant) command name, so the macro works in any locale. |
|
||
| `-` | Run the command in **script mode** — suppress dialogs, accept input from the macro string. |
|
||
| `_Enter` | Press Enter at the current prompt. |
|
||
| `Pause` | Stop and wait for the user to supply this input interactively. |
|
||
| `;` | Comment to end of line. |
|
||
| Newline | Same as a space — a separator between tokens, not a command terminator. |
|
||
|
||
### Example macros
|
||
|
||
```text
|
||
! _-Line 0,0,0 10,0,0
|
||
! _-Circle 0,0,0 5 _Enter
|
||
! _SelAll _Delete
|
||
! _-Properties _Object _Name "MyObject" _EnterEnd _Enter
|
||
! _-RunPythonScript "MyScript.py"
|
||
```
|
||
|
||
## Running Saved Scripts
|
||
|
||
### Python (`.py`)
|
||
|
||
```text
|
||
_-RunPythonScript "C:\Users\example\Scripts\MyScript.py"
|
||
```
|
||
|
||
Or, with the script folder on the search path:
|
||
|
||
```text
|
||
_-RunPythonScript "MyScript.py"
|
||
```
|
||
|
||
`_EditPythonScript` opens the legacy editor; `_ScriptEditor` (Rhino 8) opens the unified editor with Python 3, VB, and C#.
|
||
|
||
### RhinoScript (`.rvb`, `.vbs`)
|
||
|
||
Two steps: **load** the file (registers its subs/functions), then **run** a named sub.
|
||
|
||
```text
|
||
_-LoadScript "MyScript.rvb"
|
||
_-RunScript MyMainSub
|
||
```
|
||
|
||
A single `.rvb` can hold many subs; `_RunScript` chooses which to invoke.
|
||
|
||
### Search Paths
|
||
|
||
`Options → Files → Search paths` — folders listed here are scanned when you reference a script by bare filename. Without this, you must give a full path.
|
||
|
||
### Startup Scripts
|
||
|
||
`Options → RhinoScript → Startup` (and `Options → Python → Startup`) — files in these lists run once when Rhino opens. Useful for registering custom commands or aliases.
|
||
|
||
**Guard against missing document** in startup code:
|
||
|
||
```python
|
||
import scriptcontext as sc
|
||
|
||
def startup():
|
||
if sc.doc is None:
|
||
return
|
||
|
||
startup()
|
||
```
|
||
|
||
## Toolbar Buttons & Aliases
|
||
|
||
A toolbar button’s **Command** field is just a macro. To make a button that runs your script:
|
||
|
||
```text
|
||
! _-RunPythonScript "MyScript.py"
|
||
```
|
||
|
||
Set the **Tooltip** to a short description; set the icon via the button editor.
|
||
|
||
To create an alias: `Options → Aliases → New`. The alias name becomes a typed command; its value is the macro.
|
||
|
||
## Invoking Macros From a Script
|
||
|
||
```python
|
||
import rhinoscriptsyntax as rs
|
||
rs.Command("! _-Line 0,0,0 10,0,0", echo=False)
|
||
```
|
||
|
||
`echo=False` suppresses command-history output but does **not** suppress prompts — always use `-` and complete every prompt within the macro string.
|