Stars
Slow ambient star particles for astral scenes, dreamlike spaces, or void backgrounds.
Ambient effects add visible movement without replacing the full weather setup. Use them on their own or layer them with another particle or filter.
| Reference | Value |
|---|---|
| Package | FXMaster |
| Effect kind | Particle effect |
| Category | Ambient |
| Runtime type | stars |
| Exposed parameters | 16 |
Important controls
Section titled “Important controls”- Orbit: Makes stars circulate around the effect area instead of only crossing the canvas in a straight or drifting path.
- Scale: Changes the rendered size of stars. It does not change how many particles are present.
- Speed: Changes how quickly stars move and animate across the canvas. It does not change particle size or count.
- Density: Changes how many stars are visible or spawned at once. It does not change their size.
- Opacity: Controls the transparency of stars. Lower values allow more of the map to show through.
Setup notes
Section titled “Setup notes”- Lower Density works well when Stars are used as a subtle accent. Raise it when the stars should become a stronger background layer.
- Tint, Opacity, and Scale usually change the overall mood more than Density alone.
Bundled preset usage
Section titled “Bundled preset usage”| Preset | API name | Availability | Variants |
|---|---|---|---|
| Divine Light | divine-light |
FXMaster+ | Normal |
| Nullfront | nullfront |
FXMaster | Normal |
Parameters
Section titled “Parameters”The table combines the settings available for this effect in Scene and Region contexts. Scene-only and Region-only badges identify controls limited to one context. Hover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Each card also includes the default, range or choices, context, availability, API key, and control type.
stars API typeHover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Context badges identify Scene-only and Region-only controls; unbadged parameters are available in both. Hover or focus an availability condition to highlight the parameter that controls it.
| Parameter | Control | Default | Range or choices | Availability |
|---|---|---|---|---|
Below Tokens belowTokens | checkbox | Off | — | Always |
Below Tiles belowTiles | checkbox | Off | — | Always |
Below Foreground belowForeground | checkbox | Off | — | Always |
Levels levelsScene only | scene-levels | All Levels | — | Always |
Tint tint | color | #bee8ee (disabled) | — | Always |
Sound FX soundFxEnabled | checkbox | Off | — | Always |
Sound FX Sounds soundFxManualSoundIds | multi-select | Rule default | — | |
Orbit orbit | checkbox | Off | — | Always |
Orbit Distance orbitDistance | range | 0.5 | 0–1 · step 0.01 | |
Scale scale | range | 0.27 | 0.1–1 · step 0.01 | Always |
Speed speed | range | 0.27 | 0.1–1 · step 0.01 | Always |
Lifetime lifetime | range | 0.27 | 0.1–1 · step 0.01 | Always |
Density density | range | 0.3 | 0.05–1 · step 0.05 | Always |
Opacity alpha | range | 1 | 0–1 · step 0.1 | Always |
Darkness Activation darknessActivationEnabled | checkbox | Off | — | Always |
Darkness Activation Range darknessActivationRange | range-dual | {"min":0,"max":1} | 0–1 · step 0.01 |
Direct-effect API example
Section titled “Direct-effect API example”The Direct Effect API creates a separate row shown through Manage API Effects. Add a stable apiMacro_…_p or apiMacro_…_f ID when later macro calls need to update or stop the same row.
const created = await FXMASTER.api.effects.play({ particles: [{ "id": "apiMacro_wikistars_p", "type": "stars", "options": { "belowTokens": false, "tint": { "value": "#bee8ee", "apply": false }, "orbit": false, "scale": 0.27, "speed": 0.27 } }],});
await FXMASTER.api.effects.particles.stop(created.particles);For complete API behavior, scene targeting, stack ordering, and toggle groups, see the Direct Effect API guide.