Complete reference guide for Crystal Focus 10 configuration parameters
Use the search box to find CFX parameters. Try keywords like "ignition", "color", "swing", etc.
Parameter | Friendly Name | Actions | Part of |
---|---|---|---|
wakeup | Wakeup by movement | Blade profile | |
defines if the board can be woken up (leaving sleep mode) by moving the hilt. When parameter is set to 0, and once the board has entered deep sleep mode, board can only be woken up by the blade ignition (activator) switch. When set to 1 or 2, motion of the hilt while the blade is off will reset the sleep timer which maintains the hilt in idle mode, hence playing the accent led sequence matching that mode. However, when parameter is set to 1, motion on the hilt allows the board to leave the sleep state, while being set to 2, motion will not allow the board to leave sleep once that state has been reached. | |||
shmr% | Clash: Shimmer effect depth | Blade profile | |
Defines how the shimmer will "dig" the defined blade brightness during a clash or a lockup effect. A static flash is achieved by leaving that value to 0. That parameter is actually composed of 2 numbers separated by a comma to define the range to apply to the brightness modification during the shimmer. | |||
focl | Flash on Clash: enabled during Blade Lockup | Blade profile | |
defines if the Flash on Clash is enabled during Blade Lockup effect | |||
flks | Flickering blade effect | Blade profile | |
A high value produces a damaged saber effect while a small value generates subtile energy changes. The value 0 disables the effect (static blade). Keep above 4 when using a ledstrip blade to avoid competing with the pixels (inherent) refresh rate. | |||
tridentflk | Trident flicker | Blade profile | |
Trident channels have their flicker computed separately from the main channel(s) in real time, producing the effect that they live on their own and do not totally mirror the main blade behavior. In addition, they can also have their own flicker specified by this parameter, in order to produce a more dramatic flickering effect on the cross-guard. | |||
flkd | Flickering blade effect depth | Blade profile | |
depth (in %) of the energy fluctuation effect, i.e. the the range over which the LED brightness will be affected during the effect. A low value does not modify the energy very much while a high value � digs � big gaps of light intensity. To be used with the parameter flks. Set to 0 to obtain a static blade. | |||
flkon | Blade flicker during power on | Blade profile | |
flkoff | Blade flicker during power off | Blade profile | |
on_fade | Progressive fade in | Blade profile | |
enables the progressive fade in effect (combined with the ledstrip scrolling effect, this is the ScrollFade feature). Applies to both HB leds and ledstrip blades. With off_fade, those are part of the blade profiles. | |||
off_fade | Progressive fade out | Blade profile | |
enables the progressive fade out effect (combined with the ledstrip scrolling effect, this is the ScrollFade feature). Applies to both HB leds and ledstrip blades. With off_fade, those are part of the blade profiles. | |||
unstable | Unstable effect | Blade profile | |
These effects simulate an unstable blade. | |||
over_pon | Takeover blade effect | Blade profile | |
Power on blending | |||
ignd | Ignition delay | Blade profile | |
Delays the ignition scrolling or power-on fx process. Set qon so that the expected fx duration (scrolling) is qon – ignd. For example, if you want the blade to scroll out in 400 ms with a delay of 200 ms after the beginning of the power-on sound, set qon = 600 and ignd = 200. | |||
pos_flicker | Spatial flicker location | Blade profile | |
defines the spatial flicker location on the blade | |||
hcool | High cool | Blade profile | |
defines how to temper the instability. Low values make the blade return quicker to its stable while high values will make the blade overall more unstable / active. | |||
lcool | Low cool | Blade profile | |
defines how to temper the instability. Low values make the blade return quicker to its stable while high values will make the blade overall more unstable / active. | |||
sparkd | Instability spreading | Blade profile | |
defines the instability spreading on the blade (0-100% of the blade length). | |||
drift | Instability contamination | Blade profile | |
defines if the instability contaminates over the blade. Used for unstable and rain sizzle, set to 1 automatically for the fire fx | |||
mapb | Unstable dark spots | Blade profile | |
define what % of the instability will affect the blade color (dim). A high value will �dig� more in the blade color and will create darker spots. | |||
refreshfx | Blade refresh rate | Blade profile | |
defines in ms the refresh rate (and computation) of the ledstrip fx. It's supposed to be equal or greater to the flicker speed. Higher values (as a period) lead to slower refresh rate and can be used for slow effects like fire. | |||
sbolt | Size of bolt impact | Blade profile | |
list of 2 numbers, minimum and maximum size of the bolt impact. When set to 0,0 and in ledstrip mode, the bolt will make the whole blade to flash (legacy Flash on Clash) | |||
lbolt | Location of bolt impact | Blade profile | |
impact location restriction on the blade. In the example above, {15,30} forces the bolt to be at 15 pixel minimum from the bottom of the blade and 30 pixels away from the top of the blade. | |||
qbolt | Bolt impact speed | Blade profile | |
Bolt impact speed (in %). Combined with the duration parameter (and bolt size range) it defines how fast it will travel on the blade when using certain blaster bolt styles (like wave). A ballpark is to see 100% speed as ensuring the bolt energy is sure to travel the whole blade during the bolt duration. | |||
pname | Blade profile name | Blade profile | |
Gives the option to name your blade profiles! | |||
bladepower | Blade power | Blade profile | |
Control over the blade power in %. Allows for reducing the power bill without touching the colors themselves | |||
style_grafx1 | grafx config index | Blade profile | |
defines the linking between the main blade profile and the location of the grafx configuration file and files /extra/GRAFX indexed subfolders | |||
pof | Power on Force | Blade profile | |
Power on Force threshold followed by angular range (2 values [-90;90]) in which the Power on Force effect can be executed. enables the Power on Force saber ignition technique (see paragraph 'Motion activated ignition' for more detail). The parameter defines the motion threshold required to ignite the blade with a motion faking the use of the 'Force' to activate the saber. 350-500 works usually fine. | |||
used_profiles_blade | Blade profile mask | Soundfont | |
this bit-field defines some masking to apply to some blade profiles. This feature is beta and cannot be edited yet via RICE. Putting a zero in the field removes the blade profile from the browsing (using spectrum or browsing). This provides an effective way to keep a large number of blade profiles defined on the SD card while restricting it selection for a specific font. | |||
start_blade | Start blade | Soundfont | |
defines a specific blade profile to start with when this specific font is selected. Overrides the last used profile saved in prefs.txt. -1 disables the feature and let the stored value from prefs.txt be used at boot time. | |||
smooth_sharp | Swing sharpness | Soundfont | |
brings softness (< 1.0) or sharpness (> 1.0) to the mapping between the blade rotation and the smoothswing expressivity. A value of 1.5 adds a bit of exponential mapping (small blade moves are amplified). Values > 1.0 make the smoothswing engine more expressive even with small motions | |||
smooth_sens | Smoothswing sensitivity | Soundfont | |
smoothswing overall sensitivity to blade rotation (in �/s). A low value will bring the smoothswing effect to its maximum volume with a small motion. A large value will require faster rotations to bring the volume to the maximum. Works with the sharpness parameter above | |||
smooth_mode | Smoothswing mode | Soundfont | |
smoothswing mode. 0 disables the smoothswing engine for a smoothswing font. 1 is the standard smoothswing mode, 2 is the hybrid font (aka accent swing) mode for which regular swing and spins can be played if the motion exceeds the hswing threshold3 . Mode 3 uses the blade orientation to control the mix between the hum pairs and the main hum to pseudo-replicate the former CF pitch shifting effect | |||
qon | Quick on | Soundfont | |
Allows having the blade ignited in a specific amount of time rather than matching the duration of the power on sound and should not exceed the duration of any power on sounds. Almost mandatory for ledstrip blade to have a visually satisfying scrolling ignition. | |||
qoff | Quick off | Soundfont | |
Allows having the blade retracted in a specific amount of time rather than matching the duration of the power off sound and should not exceed the duration of any power on sounds. Almost mandatory for ledstrip blade to have a visually satisfying scrolling retraction. | |||
tridenton | Delay on ignition of secondairy blades | Soundfont | |
Defines the delay of the secondary blades, in the case of a cross-guard saber. Should remain < to the duration of the power on sound. | |||
tridentoff | Delay on retraction of secondairy blades | Soundfont | |
Same as tridenton but during the power-off. If zero, there is no Trident effect during the blade retraction and all channels fade out normally. | |||
fontgest | Activator font selection | Main config | |
Enables loading the next font by pressing the activator and clashing the blade. If set to 0, while in single switch mode (switch=3) and using a ledstrip blade, that same action will toggle the blade PLI on/off | |||
switch | Activation switch mode | Main config | |
selects if the saber is activated by a normally-open or a normally-closed switch. Other switches might simply have an �inverted� logic (normally closed contact). When switch is set to 1, the saber lights up when the electrical contact of the switch is closed and conversely when switch is set to 0. We recommend to use a momentary switch for the blade activation, (set switch to 2). Finally, the board also supports single switch with option 3. | |||
qkignite | Ignite from sleep | Main config | |
enables igniting the blade right after waking up from deep sleep. The saber will boot normally but will skip the boot sound and will power the blade up | |||
offp | Power off Protection | Main config | |
To avoid accidentally powering off the saber, especially when using a momentary button for activation, we added a power off protection. When this parameter is set to 1, the user must press the activation button and confirm with the auxiliary button. It is not necessary to press both buttons at the same time, keep the activation switch pressed first, then press the auxiliary switch: the blade goes off. | |||
offd | Power off delay | Main config | |
power-off delay. An alternative to A-POP� defining how long the user must press the activation switch before the blade goes off. Values from 100 to 500 ms are relevant and very efficient for just ensuring the saber won't be turned off accidentally. Set to zero if you use an anti-power off protection with parameter offp | |||
onp | Power on Protection | Main config | |
If the parameter is set to 1, you must press the aux. button after pressing / cycling the activation switch in order to ignite the blade | |||
lockup | Lockup trigger delay duration | Main config | |
our module features an auxiliary switch to trigger additional sound/visual effects. A short pressure on the switch generates the blaster effect (the saber blade stops a blaster ray), plays one of the blaster sounds. A longer pressure (maintained) triggers a blade lockup effect: while the switch is pressed, the sound lockup.wav is played in loop with some shimmering applied to the high-power LED. The parameter lockup specifies the duration of the delay before triggering the lockup effect. A short value (100 to 200) will trigger the effect almost immediately: to trigger a blaster effect, the user will have to release the button quickly. Conversely, a higher value will leave more time to produce a blaster blocking feature | |||
spectrum_mode | Color profile selection mode | Main config | |
Spectrum (color profile selection) mode. P = navigating color profile. B = navigating blade profile. AA = Aux. + Act || AT = Aux + Twist | |||
ledstrip | Qty pixels on main blade | Main config | |
enables the ledstrip support by defining the number of pixel of the main blade. 0 leaves the board in high-power LED mode. The number of pixels accounts for just one ledstrip: a blade composed of two strips of 120 pixels back to back is defined as 120 pixels | |||
auxstrip | Qty pixels on secondary blade | Main config | |
defines the number of pixels of the secondary blade, rendered on the ledstrip output | |||
tridentstrip | quillons length and offset | Main config | |
enables the trident support in ledstrip mode. Defines the quillons length and the offset at which the normal/main blade starts. Positive value will establish the quillon on the main ledstrip output LS1, negative on LS2 | |||
accentstrip | pixel accents (sequencer) | Main config | |
enables the pixel accents (sequencer). Also defined as an offset on either the main blade & strip output LS1 (> 0), or LS2 (< 0). | |||
auxaccentstrip | aux pixel accents (sequencer) | Main config | |
enables the pixel accents (sequencer). Also defined as an offset on either the main blade & strip output LS1 (> 0), or LS2 (< 0). | |||
strippower | Ledstrip power channels | Main config | |
defines which channels {#1;#4} are used to control ledstrip power or leave them mirror the blade color. <br><br>Since version 10.002 of the firmware, the general configuration uses parameter strippower (bitfield) to control which of the L- driver outputs are used for powering the ledstrip and which are still mirroring the blade color channels. For instance: strippower=1110 will configure channels #1, #2 and #3 as strip (negative) power control while channel #4 remains free for mirroring the color channel. This comes quite handy when it�s used to drive a rumbling motor or a spinning crystal chamber. <br><b>See Ledstrip blade specifics section in the manual</b> | |||
masterpower | Blade power | Main config | |
Master control over the blade power in %. Allows for reducing the power bill without touching the colors themselves | |||
blademusicstyle | iSaber visual render style | Special | |
When in ledstrip mode, iSaber will use the blade as a visual renderer of the sound when the saber is on | |||
auto-on | Automatic Power ON | Special | |
Base delay in ms followed by a % of randomness. 5000,10 <=> {4500 ; 5500} ms. <br>A new random color profile is selected at each ignition. Every 10 ignition a random blade profile is selected.<br>Example setting: 5000,10 | |||
auto-off | Automatic Power OFF | Special | |
Base delay in ms followed by a % of randomness. 5000,10 <=> {4500 ; 5500} ms. <br>A new random color profile is selected at each ignition. Every 10 ignition a random blade profile is selected.<br>Example setting: 8000,5 | |||
auto-shutoff | Automatic shutoff | Special | |
Base delay in ms followed by a % of randomness. 5000,10 <=> {4500 ; 5500} ms. <br>A new random color profile is selected at each ignition. Every 10 ignition a random blade profile is selected.<br>Example setting: 120000 | |||
auto-dim | Automatic Dim | Special | |
Base delay in ms followed by a % of randomness. 5000,10 <=> {4500 ; 5500} ms. <br>A new random color profile is selected at each ignition. Every 10 ignition a random blade profile is selected.<br>Example setting: 360000,30 | |||
bladeplistyle | PLI style | Special | |
display a PLI over the blade if no OLED is attached (and in ledstrip mode) | |||
bladeplicolor | PLI Color | Special | |
"specifies the PLI color either with the 4 channel list or the color dictionary.<br>Example: bladeplicolor=Crimson) | |||
bladeplisize | PLI size in pixels | Special | |
specifiesthe number of pixel on which to display the PLI. Maxvalue is actually the blade length | |||
bladecharge | Enables power drivers L1- to L4- to enable charging the battery without addon board | Special | |
enable any of the power drivers (L1- to L4-) that are used by strip power so that the blade charge can go thru the board and charge the battery without any add-on board. If live wire option is used, browsing the OLED or accessing blade PLI will revive the drivers and will allow for charging too even if live wire prevents the powering of the drivers in other conditions | |||
color | Blade color | Color | |
Blade color | |||
Watch our video tutorials to learn more about using CFX parameters in your lightsaber configuration.
Browse TutorialsSee visual examples of CFX blade effects that you can configure using these parameters.
View EffectsUse our desktop application to easily configure your CFX lightsaber without memorizing parameters.
Get Crystal FX DesktopBrowse our extensive library of blade profiles created by the community. Download and use them directly in your CFX lightsaber!