Skip to content

Commit 7925fcc

Browse files
committed
Added note about DAZ Script Server option
1 parent 6a1b8ae commit 7925fcc

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A powerful, configuration-driven command-line utility system that provides stand
2828
- **Extensible Architecture**: Easy to add new commands without modifying core code
2929
- **Type-Safe Arguments**: Automatic argument validation and type conversion
3030
- **Auto-Generated Documentation**: Command reference documentation generated from config
31-
- **DAZ Studio Integration**: Seamless execution of DAZ Studio scripts from Python
31+
- **DAZ Studio Integration**: Seamless execution of DAZ Studio scripts via subprocess or a high-performance [Script Server plugin](https://github.com/bluemoonfoundry/vangard-daz-script-server)
3232
- **Pro Mode**: Modern, dark-themed web interface with dynamic forms and real-time feedback
3333

3434
## Architecture
@@ -107,8 +107,8 @@ A powerful, configuration-driven command-line utility system that provides stand
107107
2. Interface layer parses input and passes to core framework
108108
3. Framework loads corresponding command class from config.yaml
109109
4. Command class processes arguments and converts to JSON
110-
5. Command spawns DAZ Studio subprocess with script path and JSON args
111-
6. DAZ Studio script executes operation and returns results
110+
5. Command executes via DAZ Studio subprocess (default) or sends REST request to Script Server plugin
111+
6. DAZ Studio script executes operation and returns results (standard output or JSON response)
112112

113113
## Prerequisites
114114

@@ -158,8 +158,11 @@ A powerful, configuration-driven command-line utility system that provides stand
158158
- macOS: `/Applications/DAZ 3D/DAZStudio4 64-bit/DAZStudio.app/Contents/MacOS/DAZStudio`
159159
- `DAZ_ARGS`: Optional additional arguments to pass to DAZ Studio
160160

161-
**DAZ Script Server mode** (requires the [DAZ Script Server plugin](https://github.com/bluemoonfoundry/vangard-daz-script-server)
162-
- `DAZ_SCRIPT_SERVER_ENABLED`: Set to `true`, `1`, or `yes` to use the REST API instead of spawning a subprocess. Default: `false`
161+
**DAZ Script Server mode** (optional integration):
162+
Available from a separate repository: [vangard-daz-script-server](https://github.com/bluemoonfoundry/vangard-daz-script-server).
163+
The Script Server is compiled as a DAZ Studio plugin and must be started within DAZ Studio in order for the scripts to connect to it. This mode provides a high-performance REST API interface.
164+
165+
- `DAZ_SCRIPT_SERVER_ENABLED`: Set to `true` in your `.env` file to enable the Script Server interface instead of spawning subprocesses. Default: `false`
163166
- `DAZ_SCRIPT_SERVER_HOST`: Hostname or IP of the DAZ Script Server. Default: `127.0.0.1`
164167
- `DAZ_SCRIPT_SERVER_PORT`: Port of the DAZ Script Server. Default: `18811`
165168

0 commit comments

Comments
 (0)