Architecture page
HISE Package File Map
Package-owned files, generated configuration, native tools, and regeneration responsibilities.
SoundSync
HISEScript package
| Path under Scripts/ | Purpose | Edit policy |
|---|---|---|
| SoundSync/Runtime/SoundSyncRuntime.js | Licensing runtime and activation flow | Package-owned; regenerate instead of saving through the HISE script editor |
| SoundSync/WebView/ | Activation interface, styles, and generated config | Keep the delivered paths together; brand through product settings |
| SoundSync/Docs/SETUP.md | Variant-specific setup and behavior | Read the copy generated with your package |
| Generated configuration and branding assets | Product identity, credentials, activation mode, colors, and logo | Regenerate after product or credential changes |
SoundSync
Native HISE package
| Path under SoundSync/ | Purpose | Edit policy |
|---|---|---|
| Scripts/SoundSyncNativeGate.js | Small project include that starts the native gate | Include from your own interface script |
| Scripts/SoundSyncNativeRuntime.js | Native runtime bridge and UI coordination | Package-owned |
| Native/include/soundsync/hise/HiseAdapter.h | HISE adapter interface | Package-owned native source |
| Native/config.public.json and branding-snapshot.json | Generated product configuration and branding snapshot | Regenerate; do not reuse another product configuration |
| WebView/License/index.html, app.js, styles.css, config.js | Native package activation interface | Keep relative paths and generated configuration intact |
| Tools/installNativeHisePackage.ps1 | Installs native sources into the project | Run against the intended project |
| Tools/applySoundSyncHiseApiPatch.ps1 and verification tools | Patch and verify the HISE source API | Use with the intended source checkout before rebuilding HISE |
| Tools/patchExportedHiseVst3Project.ps1 | Connect native enforcement after plugin export | Reapply to newly exported projects |
| Docs/SETUP.md and Native/README.md | Build and release instructions | Follow the downloaded variant, not an older screenshot |
Generated files are product-specific
A package can contain a product-scoped secret as part of its intended client model. Do not publish the package as a generic screenshot attachment or commit credentials into a public repository. Product keys do not grant developer dashboard or partner access.
Keep your DSP, editor customization, and project files separate from package-owned files. Regeneration replaces generated values; it does not automatically merge custom modifications.
SoundSync
Generated files produce customer-facing package screens
The HISE activation screen is the visible customer result of generated config, runtime files, branding values, support links, and activation mode setup.
SoundSync
Store files support product browsing and ownership
The HISE Store and My Products screenshots show the package surfaces developers should regression-test after regeneration and release packaging.
