×
DOF Builder Guide: Creating Advanced Effects
Quick Start: The 1-2-3 Workflow
Follow these steps in order to ensure your effects are applied correctly:
- Setup Cabinet Toys: Click the blue button at the top to select only the toys you have (e.g., Flipper Buttons, Undercab). This simplifies the view.
- Select Target & Configure: Click a toy button in the main window (e.g., "RGB Undercab"), then use the left-hand panel to build your layers (Colors, Blink, etc.).
- Apply & Generate: Click the large green APPLY LAYERS TO SECTION button to finalize the code for that toy. Then copy the code from the table on the right to your spreadsheet.
This tool simplifies the process of creating complex DirectOutput Framework (DOF) effects by breaking them down into 4 additive layers. Instead of writing cryptic codes manually, you use the sliders and inputs, and the tool generates the correct configuration string for you.
[Image of additive color mixing chart]
1. Effect Basics: How Layers Work
DOF is Additive. This means you don't "switch" between Layer 1 and Layer 2. Instead, they are all active at once and mix together.
Example:
- Layer 1: Set to
Blue (Static/Solid). This acts as your background color.
- Layer 2: Set to
Red with Blink effect.
Result: The strip will be constant Blue. Every time the Red Blink fires, the Blue + Red combine to make
Magenta. The Blue never turns off; the Red just adds to it.
2. Using the Controls (User Guide)
A. Effect Type
- Static (Solid): Always on. Use this for background colors.
- Blink / Pulse / Flicker: Periodic effects.
- If you choose these, the Duration control sets the Speed (e.g., Duration 500 = fast strobe, Duration 2000 = slow breath).
- Gradient Chase: A special mode that reveals a new panel for building moving rainbows or police lights.
B. Timing & Sequence
The behavior of the Duration field changes based on the "Sequence (Timed)" checkbox:
- Unchecked (Cycle Mode): The effect repeats forever. Duration = Cycle Speed.
- Checked (Sequence Mode): The effect plays once and then stops. Duration = Total Lifespan. Use this for "one-shot" effects like explosions triggered by a solenoid.
C. Position & Movement
You can restrict an effect to a specific part of the strip or make it move.
- Left (AL) & Width (AW): Use these sliders to create "zones".
Example: Set Layer 1 Left to 0 and Width to 50 for a "Left Side" effect. Set Layer 2 Left to 50 and Width to 50 for a "Right Side" effect.
- Shift Speed: Makes the effect scroll.
Example: Set Shift Speed to 50. The entire pattern will travel across the strip every 2 seconds.
D. Density & Sparkle
Create fire, snow, or stars using these controls.
- Density %: Determines how many LEDs are lit at once. (0% = None, 100% = Solid).
- Sparkle Fade: Adds a "tail" to the sparkles so they fade out slowly (like embers) instead of blinking off instantly (like digital noise).
3. Recipes: How to Build Common Effects
Recipe 1: The "Police Beacon"
- Select Gradient Chase from Effect Type.
- Color 1: Red (25% Length).
- Color 2: Black (25% Length).
- Color 3: Blue (25% Length).
- Color 4: Black (25% Length).
- Blending: Set to 10-20% for smooth transitions.
- Shift Speed: Set to 300 (Fast spin).
Recipe 2: "Starry Night" Background
- Layer 1: Blue, Static, Brightness 20% (Dim background).
- Layer 2: White, Blink.
- Density: Set to 10% (Sparse stars).
- Sparkle Min/Max: 100 / 500 (Random blink speeds).
- Sparkle Fade: 300ms (Smooth twinkling).
Recipe 3: "Explosion" Flash
- Effect: Pulse.
- Color: White or Yellow.
- Sequence (Timed): CHECKED.
- Duration: 600ms (Total time).
- Fade (F): 600ms (Fade out over the whole duration).
- Result: A bright flash that immediately fades to black when triggered.
4. How to Use with the Spreadsheet
Once you have designed your effects and clicked "Apply Layers to Section", you need to transfer these codes to your DOF spreadsheet file. Here is how:
- Copy the Code: In the "Staged Output" table on the right, locate the section you just modified (e.g., PF Right Effects MX HD). Copy the long string of text in the second column (e.g.,
Red Blink 500 / Blue On).
- Open Your Spreadsheet: Open your DOF spreadsheet file (e.g.,
DOF Option.xls) or login to the DOF Config Tool online.
- Find the Column: Look at the top row (Header). Find the column that matches the section name exactly.
- If you copied code for PF Right Effects MX HD, find the column labeled PF Right Effects MX HD.
- If you copied code for Flipper Button MX, find the column labeled Flipper Button MX.
- Find the Row: Locate the row corresponding to your E Code (e.g., E2000, E2301, etc.).
- Paste: Paste the copied string into the cell where that Row and Column meet, or into the appropriate section in the online DOF Config Tool.
- Repeat: Do this for every section you have configured.
Tip: You can create multiple effects for the same E-Code. For example, E2000 can trigger a flash on "PF Right Flashers" AND a color shift on "RGB Undercab". Just paste the respective codes into both columns in the same E2000 row.
Important: The CSV Export section is for VERY advanced users who know how to merge CSV files.
For most users, we recommend simply Copying and Pasting the generated strings from the "Staged Output" table directly into your spreadsheet as described above.
5. Technical Glossary (The Raw Codes)
The tool generates a string of codes. Here is what they strictly mean, for advanced users editing INI files manually.
Geometry Variables
AL (Area Left): X-axis start position (0-100%). Default 0.AT (Area Top): Y-axis start position (0-100%). Default 0.AW (Area Width): Active width (0-100%). Default 100.AH (Area Height): Active height (0-100%). Default 100.
Motion Variables
AS (Area Shift): Velocity in %/sec. Positive = Right, Negative = Left.AA (Area Acceleration): Change in velocity over time (%/sec²).
Noise/Sparkle Variables
AFDEN (Density): Target density of lit pixels (0-100).AFMIN / AFMAX: Minimum/Maximum duration (ms) for a random pixel event.AFFADE: Fade-out duration (ms) for a random pixel event.
6. Resources
For more information, visit the following community resources: