DOF Pro-Series Simulator

The DOF Pro-Series Simulator is a browser-based digital twin of your virtual pinball cabinet's lighting and toy system. It parses the same configuration files used by the DirectOutput Framework (DOF) and renders your LED matrix effects, addressable LED strips, RGB toys, and physical toy indicators in real time no hardware required.

Load your cabinet configuration files, select a ROM table, fire triggers with a click, and watch your exact DOF lighting design play out on screen exactly as it would on the physical cabinet.

Application Sections at a Glance

System Requirements

• Any modern browser (Chrome 90+, Edge 90+, Firefox 90+, Safari 15+). No install. No server.
• Your DOF configuration files generated by the online DOF Config Tool and stored locally in your DOF installation folder (typically C:\DirectOutput\Config\).
• Internet connection at first load to fetch two CDN libraries (SheetJS, sql.js). Subsequent sessions can run offline if the browser has cached those scripts.

Organize Your Files First

Disclaimer & Legal Notice

This software is provided free of charge for the virtual pinball community. It is not affiliated with or endorsed by the DirectOutput Framework project, VPUniverse, PinUp Popper, or any other third-party platform or community referenced herein.

Configuration Files

The simulator requires your actual DOF configuration files to operate. These are generated by the online DOF Config Tool hosted at VPUniverse and stored in your local DOF installation. The typical path on a Windows-based virtual pinball cabinet is C:\DirectOutput\Config\. Sample files also available in the Resources section.

DOF Folder Load + Manual Fallback

The Configuration panel is built around a folder-first DOF workflow. Choose your DirectOutput config folder, load the standard DOF files in one pass, then use the manual slots only when you need to add or replace a specific file.

• Folder-first: Use Import DOF Folder to scan the selected folder root for the standard DOF install files.
• Role detection: DirectOutputConfig files are still classified by content into Physical, RGB, and Addressable/MX roles using [Config DOF] structure and channel signatures.
• Manual fallback: Advanced Manual Slots stay collapsed until you need to add, replace, or repair a specific file.
• Root folder only: Keep the standard DOF files together in one folder root. Subfolders are ignored by the folder loader.
• Green required state: Required labels/slots turn green when valid required data is loaded, signaling the session gate is satisfied.

Mandatory Files

Optional Files

Pinup Popper Menu System Files

File Persistence

Resume Last Workspace vs Start Clean

Builder Bitmap Auto-Match

When you import a table JSON into the DOF JSON Builder, the app now checks the currently imported DOF folder for a GIF whose filename matches the table's ROM name. If a matching ROM.gif exists in the folder root, it is loaded automatically into the Builder bitmap source.

• Example: importing a table JSON whose ROM is flashgdn will auto-load flashgdn.gif if that file exists in the imported DOF folder root.
• Match rule: the match is exact by ROM filename (case-insensitive), not by human table title.
• Fallback: if no matching GIF is found, use Load Table Bitmap manually in the Builder BITMAP section.

Confirm Files & Continue

The Confirm Files & Continue button is the session gate. It requires the Addressable/MX INI slot (f-ini) to be loaded with valid [Config DOF] data, then unlocks table selection and collapses the Configuration panel for workspace room.

Once collapsed, the panel can be reopened with [+]. The INI Guide button in the Configuration header remains available so you can verify role mapping/format rules while loading or troubleshooting files.

Table View

Table View is the primary operating mode. After confirming your files, it lets you select any ROM from your Config30 and manually fire its DOF triggers to observe the resulting effects in real time.

ROM Selection

Virtual pinball games are identified by their ROM name the filename of the original arcade ROM image that the game emulates. The DOF Config Tool indexes every table by its ROM name, not its display title. For example, AC/DC may have ROM variants such as acd_168hc, acd_170, acd_170hc, and several others. Each ROM variant can have distinctly different trigger assignments, color schemes, and effect definitions reflecting differences between game versions or regional variants of the original hardware.

Triggers (W / S / E / L)

Each table's DOF code is driven by trigger events that correspond to events on the physical (emulated) pinball machine. The simulator presents these as clickable buttons in the Triggers panel:

Trigger Buttons Momentary and Latched

Each trigger button supports two firing modes:

• Momentary (M): The trigger fires while the button is held and clears the moment it is released. This mimics a solenoid pulse or a brief switch contact the most common real-world firing mode.
• Latched (L): Clicking once activates the trigger and it stays active until you click again to deactivate it. This is useful for simulating sustained states a mode running, a lamp held lit, or an always-on channel.

Layer Badges ([#])

A highlighted badge with a number (e.g. [3]) on a trigger button indicates that this trigger drives effects on that many distinct Z-layers simultaneously. Multiple layers allow complex composed effects for example, a red fill on layer 1, a sparkle overlay on layer 3, and a comet on layer 5, all fired by the same trigger. Click the badge to open the Layer Inspector for that trigger. See the Inspectors section for full details.

Multi-Toy Triggers

A single trigger (e.g. S10) frequently drives multiple physical outputs simultaneously a flasher on output 3, a solenoid on output 7, and a matrix effect on output 13 may all fire from the same event. The simulator renders all of them in parallel, giving you an accurate picture of the full cabinet response to any given game event.

Animation Simulator

The Animation Simulator lets you browse and preview all animation E-code entries in the pinupmenu section of your DirectOutputConfig30.ini file. For each entry it renders the corresponding GIF animation frame on the LED matrix and simultaneously fires the associated LED strip and RGB toy effect outputs giving you a pixel-accurate preview of how your cabinet will react during each Pinup Popper menu animation.

Load Effects & Enable Selector

Click Load Effects & Enable Selector to parse the uploaded effects file and GIF. The app will extract all E-code entries, decode every GIF frame in-browser, and resolve display names from the PUPDatabase.db if it was loaded. This process may take a few seconds for large files. Once complete, the load bar collapses and the entry list becomes active. A Files loaded / Reload bar replaces it click this to re-open the file loader if you need to swap files.

Output Mapping ( OUTPUT MAPPING)

Before any LED strip or toy effects will display, you must map the spreadsheet's effect output columns (e.g. "PF Left MX HD", "Left Side MX HD") to your cabinet's actual hardware outputs using the OUTPUT MAPPING panel. Each checkbox row associates one effect output column with a specific output on your cabinet. This mapping is persisted to localStorage you only need to configure it once. The panel is collapsible via its header; click again to toggle between expanded, docked, and hidden states.

Entry List & Legend

Entries are listed with type and status badges:

• T   Table entry (linked to a specific game ROM)
• PL   Playlist entry (generic/non-game animation)
• ANIM   Animated entry (multi-frame GIF cycles automatically)
• 3   Multiple effects for one E-code (click to expand sub-selector)
• *   Warning: = dimension mismatch (silently clamped), * = out-of-range frame index

Filter buttons allow you to show Tables, Playlists, or Both. The sort button toggles between E-code order and alphabetical order. The search box filters by name or E-code number in real time.

Multi-Effect Entries (#)

When a single E-code has multiple variant effects assigned to different ROM tables, it shows a N badge. Clicking it expands a sub-selector row of buttons, one per variant ROM. Each button shows the table/ROM name; clicking it renders that specific variant's bitmap and LED strip/toy effects.

Table Code View

Switching to Anim Sim mode changes the Code Monitor's [ Anim Sim ] button to show a live spreadsheet grid of the loaded effects file. As you select entries from the Anim Sim list, this grid auto-highlights the corresponding row. The grid is read-only (pasting is not allowed) but you can double-click any cell to copy its content. Column headers describe each data field; effects begin with the Custom MX1 column and continue rightward through all effect output columns (LED strip and toy assignments) to the right. The Compact/Expanded toggle button adjusts row height for density vs readability. This view is read-only no pasting is permitted.

Bitmap Rendering Limitation

LED Matrix Display

The LED Matrix Display is a pixel-accurate representation of your cabinet's WS2811 LED matrix. Its dimensions (width height in LEDs) are read directly from your Cabinet.xml file the grid you see has exactly as many cells as your physical matrix has addressable LEDs.

Every active effect is rendered at ~60 fps using the browser's requestAnimationFrame loop. The simulator evaluates all DOF parameters in real time: position (AL/AT), size (AW/AH), motion (AS + direction), fade (FU/FD), blink (rate + BPW), sparkle (AFDEN), and shape sprites (SHP). The result is a faithful reproduction of what your actual hardware would display.

Brightness Slider

Adjusts the visual intensity of all lit pixels using a CSS filter multiplier (0.5 to 3). This has no effect on the underlying effect calculations it is purely a display aid for different ambient lighting conditions. Default is 1.0.

Gap Slider

Adds physical pixel spacing between LED cells (0 to 6 px). At 0, pixels are flush giving a solid color fill appearance consistent with high-density matrices. Increasing the gap creates a more visually distinct "LED grid" look that better approximates lower-density physical installations. Default is 0 px.

Trim Slider

The Trim slider is a global preview-only bitmap calibration control. It adjusts how aggressively soft edge pixels from GIF-backed bitmap effects are trimmed before rendering to the matrix. Lower values preserve more edge information; higher values produce a tighter, thinner rendered bitmap. Trim does not modify the authored DOF string.

Bottom Indicator Legend

The status bar beneath the matrix groups live non-matrix activity by family: RGB Toys, Flashers, Bumpers, Strobes, Solenoids, Buttons/Inputs, and Other. These indicators help you understand what else is firing alongside the matrix image without opening another panel.

Active Toys & Indicators

The Active Toys & Indicators panel displays a visual indicator for every toy defined in your cabinet configuration that appears in the loaded table's code. Indicators activate when their corresponding trigger fires and display in the color specified by the active DOF effect string.

Indicator Types

• Circle () Standard toy output: flasher, strobe, beacon, contactor, or any non-shape toy. Lights to the full effect color.
• Filled Square () A shape-based toy, meaning the DOF code uses a SHP parameter to render a sprite on that output.
• Italic name A toy with multiple layers assigned. An italic display name indicates that more than one Z-layer is associated with this toy's trigger(s). Click the toy name or its inspect icon to open the Toy Inspector.

Color Accuracy

Each indicator lights up in the exact color resolved from the DOF effect string including custom colors defined in your [Colors DOF] section, the full 122-color DOF named palette, and inline hex values. If a toy's effect uses Blink, the indicator will pulse accordingly. Fade parameters (FU/FD) affect the color intensity in real time.

Using the Toy Inspector

Click any toy indicator to open the Toy Inspector for that toy. See the Inspectors section for full details. When the inspector is open, the Active Toys panel suspends normal trigger-driven updates only the inspected toy's effects are shown.

Legend

The legend is displayed in the section header bar: =Tag =Shape italic=Multi-layer (Click Icon to Inspect Triggers). The activity LED (small dot) in the section header pulses when any toy in the panel is currently active.

Real-Time Code Monitor

The Code Monitor is the heart of Table View. It displays the raw DOF effect string for the currently selected ROM table, exactly as it appears in DirectOutputConfig30.ini after all @variable@ macros have been expanded. The monitor is live-editable any change you type takes effect immediately on all visual outputs.

CSV Format

DOF's configuration file stores effect strings in CSV format. Each comma-separated column maps to one hardware output. The simulator resolves which physical toy each column drives using the output-to-toy mapping from Cabinet.xml. Effects within a column are slash-separated layers: S4 Red/ON Blue FD200/.

Color Coding

Each CSV column in the Code Monitor is highlighted in a distinct color that matches the corresponding output's color in the Format View legend and in the strip rack. This makes it visually straightforward to identify which column of code drives which physical output.

Toolbar Buttons

[ Format ]

Toggles the Code Monitor between its raw editable form and a Formatted Code View. The formatted view separates each layer onto its own line and labels it with the output name and color ideal for reading complex multi-layer effect strings. Editing is not possible in Format View; return to the normal Code Monitor to make changes.

[ Anim Sim ]

Toggles the Anim Sim Spreadsheet Grid in place of the Code Monitor. This is a live color-coded grid view of the loaded Anim Sim effects file (20 columns). Selecting an entry in the Anim Sim list auto-highlights the corresponding row. Double-click any cell to copy its content. Column headers describe each field; effect data begins at the Custom MX1 column and continues through all effect output columns (LED strip and toy assignments) to the right. The Compact/Expanded toggle button adjusts row height for density vs readability. This view is read-only no pasting is permitted.

[ Code Sim ]

Opens the Code Simulator floating panel. See the full Code Sim description below.

[ Code Ref ]

Opens the DOF Code Reference floating panel a quick-reference popup with tabbed documentation covering Triggers, Area parameters, Motion parameters, Color names, Timing/fade parameters, Special Effects, and a pre-built Examples library. This panel is draggable and resizable. The Examples tab contains ready-made effect strings you can copy and experiment with in the Code Sim or adapt for your own effects.

Code Simulator ([ Code Sim ])

The Code Sim is a floating, draggable panel for quick effect prototyping. Paste any valid DOF effect string and fire it against any combination of output targets no trigger code required. It is completely independent of the loaded table.

• Output Targets: Checkboxes select which hardware outputs receive the effect. The Matrix is checked by default. After session confirmation, all named strips and RGB toys from your config files are also listed. Any combination can be checked simultaneously the same effect string is sent to all checked targets.
• M (Momentary): Fires the effect while the button is held. The button uses a document-level mouse-up listener so releasing the button while dragging away from it still correctly clears the effect.
• L (Latch): Toggles the effect on/off. While latched, finite effects (fade-outs, timed pulses) automatically re-fire when their cycle completes, creating a continuous loop. This allows you to preview one-shot effects (like a FD200 comet tail) playing in a repeating loop for detailed inspection.
• (Loop): Auto-replays the effect when all timed effects expire. Untimed (permanent) effects do not block the loop cycle only effects with FU, FD, dur, or maxDur count for loop timing.
• Clear: Removes all Code Sim effects from all outputs immediately and resets the latch state.
• Clear Code: Clears only the text in the input textarea, without affecting any currently playing effects.

Cabinet Strips & Toys

The right panel is the visual representation of your cabinet's actual hardware layout. Every strip, RGB toy, and physical toy shown here corresponds to a real device in your installation.

LED Strips

Each LED strip is rendered as a horizontal row of individual LEDs, with exactly as many cells as the strip has addressable pixels (as defined in Cabinet.xml). Active effects scroll, fade, and blink in real time the strip display is fully synchronized with the matrix rendering loop. Strip name and LED count are displayed in the strip rack header.

1PX Mode

The 1PX toggle switch collapses any multi-LED strip down to a single pixel, emulating a one-pixel strip. This is useful for testing how your DOF effect code would look on a single-output RGB device since many RGB toys behave as a single addressable pixel, 1PX mode lets you preview exactly what that toy would display. Area, motion, and sparkle parameters become irrelevant in 1PX mode, so the strip simply shows the resolved base color of the active effect.

RGB Toys

RGB toys (loaded from DirectOutputConfig2.ini) are physical devices driven by three independent LED channels (R, G, B). The simulator resolves the effective color by examining the active DOF channels for each toy and either applies the named color directly (when all channels share the same color name) or blends the channels by their physical diode position. The indicator lamp for each RGB toy displays this resolved color in real time.

Physical Toys Check to Activate

Physical toys (loaded from DirectOutputConfig.ini) are listed with a checkbox labeled Check to Activate. This checkbox controls only whether the visual indicator lights up when the toy's trigger fires. It has absolutely no bearing on the actual DOF code, the routing of signals, or any hardware behavior it is a purely visual on/off switch for the indicator lamp in the simulator.

This is useful because many DOF configs include always-on channels a lit "Start" or "Exit" button that is permanently active at the table level. With the checkbox unchecked, that toy's indicator remains dark, preventing it from creating visual noise; you can then enable it selectively when you want to see it respond to specific triggers.

Inspectors

The simulator provides two floating analysis panels that give you surgical visibility into complex multi-layer, multi-trigger effect configurations. Both inspectors are draggable, resizable, and take precedence over all other display modes while open.

Layer Inspector (Trigger Layers)

The Layer Inspector is opened by clicking the highlighted [#] badge on any trigger button that shows a layer count. It shows all effects associated with that specific trigger, organized by Z-layer.

How to use it

1. Click a trigger's [#] layer badge (e.g. [4] indicates 4 layers). The Layer Inspector opens.
2. By default, ALL layers are shown simultaneously the matrix and toy displays update to show the combined effect of all layers for that trigger.
3. Click an individual layer button (e.g. L1, L3, L5) to isolate just that layer. The matrix display updates to show only that layer's effect.
4. The Currently showing status line updates to reflect the active filter.
5. Click All to return to the combined view.

Toy Inspector (Toy Triggers)

The Toy Inspector is opened by clicking any toy indicator in the Active Toys & Indicators panel. It shows all triggers that affect that specific toy, and allows you to examine the effect each trigger produces on each layer.

How to use it

1. Click any toy indicator. The Toy Inspector opens showing the toy's name in the header.
2. The LAYER FILTER section shows all Z-layers on which this toy has defined effects. By default, All triggers are shown.
3. Click a layer button (e.g. L2) to filter the trigger list to only those triggers that have an effect on that specific layer for this toy.
4. The TRIGGERS section lists all trigger codes that affect this toy (on the current layer filter). Click any trigger to fire it in isolation the matrix and toy displays update to show exactly what that trigger produces for this toy.
5. Each layer may have a completely different set of triggers. Use the layer filter to navigate between them.

Header Panel

Version Number

The current version is displayed in the DOF PRO SIMULATOR brand area in the top-left corner of the header. Updates and release notes are maintained in the embedded JavaScript source for each build.

Inspector Active Indicator

When either the Layer Inspector or the Toy Inspector is open, a pulsing INSPECTOR ACTIVE badge appears in the header. This is a visual reminder that the display is in inspection mode and not reflecting normal trigger-driven operation. All outputs are currently filtered through the inspector's logic.

DOF Builder

Clicking the DOF Builder button switches the application from the Simulator view to the DOF Builder view a dedicated multi-layer effect designer workspace. While the Builder is active, the simulator's three-panel layout is replaced by the Builder's own layout (effect controls, matrix preview, and staged output table). The simulator's rendering loop pauses. Click the button again (labeled Simulator when in Builder mode) to return to the simulator. Builder state is persisted via localStorage your layers, section configs, and E codes are preserved between sessions. See the DOF Builder tab in this help document for full details.

Theme Selector

Nine color themes are available from the dropdown:

• Blueprint (Default) Deep navy background, amber/gold accents. Styled after engineering blueprint drawings.
• Dark Dark charcoal background, blue accents. Recommended for low-light cabinet environments.
• Light Light gray/white background. Better for daytime use or screen sharing.
• Retro Warm amber-on-dark palette with a vintage CRT feel.
• Matrix Black background, bright green accents. Classic terminal aesthetic.
• Solarized Warm earthy tones based on Ethan Schoonover's Solarized Dark palette.
• One Dark Popular code editor theme with muted blue-purple tones.
• Monokai Rich dark theme with vibrant accent colors from the classic Monokai scheme.
• Catppuccin Soft pastel accents on a warm dark background. Community-favorite aesthetic.

Theme selection is not currently persisted between sessions you will need to re-select your preferred theme on each load. The DOF Builder uses a fixed amber/navy palette and is not affected by theme changes.

Stats Dropdown ( Stats)

The Stats button opens a live summary of all data loaded in the current session:

• Config30 Tables Number of ROM entries loaded from DirectOutputConfig30.ini
• Custom Colors Named colors defined in your [Colors DOF] sections
• Config1 Tables ROM entries from DirectOutputConfig.ini (physical toys)
• Config2 Tables ROM entries from DirectOutputConfig2.ini (RGB toys)
• @Variables Macro substitution variables from [Variables DOF]
• Anim Sim Effects E-code entries loaded from the Animation Simulator effects file
• Cabinet Matrix Matrix dimensions (W H LEDs)
• LED Strips Number of strips defined in Cabinet.xml
• Shape Sprites Number of shapes loaded from DirectOutputShapes.xml

Help & Reference

Opens this document. The Help & Reference is the primary resource for all aspects of the simulator and builder. The Technical Reference section contains the full DOF parameter table, INI file structure documentation, and deep links for further research.

DOF Builder Overview

The DOF Builder is a multi-layer visual effect designer that generates DOF code strings. Instead of hand-typing complex effect codes, you configure layers with a visual interface pick colors, adjust timing sliders, set area coverage, add motion and sparkle and the Builder generates the exact DOF string you need.

How It Works

1. Switch to the Builder by clicking DOF Builder in the header.
2. Select a Target Section (output destination for your effect).
3. Configure one or more layers with color, effect type, timing, area, and optional shapes.
4. The Generated DOF String updates in real time at the top of the left column.
5. Enter an E Code (the trigger code for this effect) and click Apply Layers to Section.
6. The generated string is staged to the selected section in the Staged Output table.
7. Repeat for each section that needs an effect.
8. Use Send to Code Sim to preview the effect in the simulator, or Generate CSV to export all staged sections.

Builder Layout

The Builder replaces the simulator's three-panel layout with a dedicated effect design workspace.

Left Column Effect Designer

The left column contains all the controls for building your effect, organized into collapsible accordion sections:

• Apply Button Commits the current effect to the active Target Section.
• Generated DOF String Live preview of the code being generated.
• Layer Tabs Start with 6 layers and add/copy/delete layers as needed.
• Color Grid DOF named color palette used by the app.
• Bitmap GIF crop, frame, animation, and behavior controls for MX bitmap work.
• Effect & Timing Effect type, fade, duration, intensity controls.
• Plasma Plasma-only controls for APS/APD/APC authoring.
• Area & Motion Spatial positioning and scrolling.
• Sparkle Per-pixel random twinkle parameters.
• Shapes SHP shape dropdown.

Center Visual Preview

The center area shows your effect rendering in real time:

• Target Section buttons Select which output to stage your effect to.
• Target Filters Limit the button bar to specific toy families or edited/modified sets.
• E Code field Enter the trigger code (e.g., E2000).
• Matrix Preview Full matrix rendering with your cabinet's dimensions.
• Preview Bar Pause/Restart, Link Sync, Brightness, Gap, Trim, and visibility controls.
• LED Strip Preview Horizontal strip rows matching your cabinet's strips.
• Bottom Legend Shows the live RGB toy / flasher / bumper / solenoid / button indicator families beneath the matrix.
• Staged Output Table All 13 output sections with their generated strings.

Matrix & Strip Display Controls

The matrix and LED strip previews can be individually shown or hidden using their visibility toggle buttons. Hiding the matrix lets you focus on strip-only effects; hiding the strips gives maximum space for the matrix preview. Visibility has no effect on code generation output the Generated DOF String always includes all parameters regardless of what is displayed.

The LED strips panel includes a checkmark selector that lets you choose which strips are visible in the preview. This is useful when working on effects destined for a specific strip hide the others to reduce visual clutter.

Both the matrix and LED strips can be scaled up or down by 10% from the dimensions read from your Cabinet.xml file. Use the + and buttons to resize the display. This is purely visual it does not affect the effect parameters or generated code.

The matrix preview also has Brightness, Gap, and Trim controls. Brightness adjusts overall visual intensity (0.5 to 3), Gap sets pixel spacing (06px) to simulate different LED panel densities, and Trim is a global bitmap-preview calibration slider that thins or preserves soft bitmap edges without changing the authored DOF code.

The lower matrix legend is a live status bar for non-matrix outputs. It groups currently active RGB toys, flashers, bumpers, strobes, solenoids, and buttons/inputs so you can see at a glance which non-matrix families are contributing to the current preview scene.

The Builder workspace supports global layout and table layout saving. Global layout applies your preferred card order/geometry across all tables, while table layout stores a table-specific arrangement for the currently imported JSON. Use the Save/Reset buttons beneath the preview to keep whichever layout mode matches your workflow.

Multiple panes in the Builder are vertically resizable, including the Generated DOF String window and card/list regions. Resize grips let you tune the workspace density without affecting any authored data.

Layer System

The Builder starts with 6 independent layers and supports dynamic layer management. Use Add, Copy, and Delete to grow or reduce the stack as needed. Each layer can have its own color, effect type, timing, area coverage, motion, sparkle, and shape. Layers are composited using a painter's algorithm higher Z-order layers paint on top of lower ones.

Layer Tabs

Layer tabs sit below the Generated DOF String. They initialize at L1L6 and expand dynamically as you add or copy layers. Each tab shows:

• Color indicator A small colored bar showing the layer's active color.
• Z-order label Shows the layer's Z value and whether it's TOP or BOT in the stack.

Click a tab to switch to that layer's controls. Click Clear Layer to reset the active layer.

Layer Output

Each active layer generates a segment of the DOF string. Multiple layers are joined with / separators:

Color Selection

The Color section displays the complete DOF named color palette recognized by the DirectOutput Framework. Click any swatch to set the active layer's color.

Use Source Art

When a bitmap-backed layer is selected, the Use source art toggle tells the Builder to preserve the bitmap's original pixel colors instead of tinting the bitmap through the selected DOF color. This is useful for logos, artwork, and menu-style GIF frames where the source image already contains the intended palette.

DOF Named Color Palette

Showing a representative subset. The full named-color palette is available in the Builder's Color section and in the DOF Parameter Reference.

Bitmap Controls

The BITMAP accordion is the Builder control set for GIF-backed matrix imagery. It lets you assign a sprite sheet to the active Builder session, crop a portion of that GIF, choose which frames to play, and map the result to any MX-capable target section.

What You Need

• JSON Builder workflow: import the table JSON first so the Builder knows which table and ROM you are editing.
• Bitmap source: load the table bitmap GIF manually with Load Table Bitmap, or let the Builder auto-match a ROM.gif from the imported DOF folder when one exists.
• MX target: bitmap output only renders on MX/matrix-style targets such as Custom MX 1, PF Left/Right/Back Effects MX, or the HD MX sections.

Bitmap Control Map

Bitmap Timing Note

The Builder currently follows the authored DOF bitmap timing, not the original embedded GIF timing. In practice that means:

• AAC controls how many frames are played.
• AAF controls how fast they are played.
• If no AAF is present, playback falls back to the simulator's default bitmap frame timing.

Step-by-Step: Put a Bitmap on the Matrix

1. Import the table JSON in DOF JSON Builder.
2. Confirm the correct table is active and select the target output card/trigger you want to edit.
3. Load the bitmap GIF with Load Table Bitmap, or let the auto-match load the table's ROM.gif.
4. Check the row(s) you want the Builder to write back to, or create a new row with + New.
5. Open the BITMAP accordion and enable Hold Preview so the image stays visible while you tune it.
6. Use Resolved Frame / ABF to find the source frame you want.
7. Set ABL, ABT, ABW, and ABH to crop the exact region of the GIF you want to display.
8. Set AAC, AAF, AAD, AAS, and AAB if the bitmap should animate instead of staying on a single frame.
9. Use the matrix Trim slider above the preview to thin or preserve soft bitmap edges while you judge the rendered look. This is preview-only and does not write into the DOF string.
10. Watch the Generated DOF String update live as you change bitmap parameters.
11. Apply the layers to the correct target section or export the JSON once the trigger looks correct.

Effect & Timing

This section controls how the layer's color behaves over time.

Effect Types

Timing Parameters

Plasma Parameters (APS/APD/APC)

Plasma Controls

Plasma is available in the Builder Effect Design controls and generates DOF plasma tokens directly in the output string. Use it for animated flowing fields on matrix/strip targets.

Area & Motion

Area & Motion controls define where the effect appears on the matrix and how it moves.

Area Parameters

Motion

Step Motion Controls

Sparkle Effects

Sparkle creates a random per-pixel twinkle effect individual pixels randomly turn on and off, creating a glittering or twinkling appearance. This is commonly used for star fields, electrical sparking, or adding visual texture to solid fills.

This creates a sparse white sparkle 8% of pixels lit at any time, each staying on for 150250ms.

Shapes

Shapes (SHP) are predefined pixel patterns from the DirectOutputShapes library. They render as sprites on the matrix within the layer's area, adding visual complexity beyond solid fills and sparkle.

Using Shapes

Open the Shapes accordion, enable the checkbox, and select a shape from the dropdown. The shape renders immediately in the preview. Common shapes include:

• SHPLetterAZ, SHPDigit09 Alphabet and number characters
• SHPRoundPulse, SHPSquarePlop Animated expanding patterns
• SHPRoundAndRound Rotating circular animation
• SHPArrowLeft, SHPArrowRight Directional arrows
• SHPFillLeftRight, SHPFillTopBottom Progressive fills

Target Sections & Staged Output

The Target Section buttons above the matrix preview determine where your effect will be staged. Each section corresponds to an output column in your DOF configuration.

You can isolate any target section by clicking its button directly, or narrow the button bar using the Builder filters above it. This makes it easier to work on only MX matrix/strip sections, only RGB toys, only flashers, or just cards that are modified/edited.

MX Sections (Full Effects)

Sections containing "MX" in their name are addressable LED outputs. They receive the complete generated DOF string with all effects, timing, area, motion, sparkle, and shapes:

RGB-Only Sections (Color Only)

Sections without "MX" are single-color RGB toys. They can only display one color at a time no effects, timing, or spatial parameters. The Builder automatically strips the output to just E{code} {color}:

Link / Sync System

The matrix preview toolbar includes a LINK SYNC toggle. When sync is enabled, linked cards can fire together so you can preview the same trigger across multiple related sections at once. In JSON Builder, each card also has its own Sync checkbox. A card must be checked into Sync before it participates in linked preview firing.

• Sync OFF: preview only the active card or explicitly triggered target.
• Sync ON: fire the same trigger across all cards that are currently checked into Sync.
• Practical use: keep left/right paired sections linked while designing, but temporarily uncheck a card when you want to isolate one side.

Staged Output Table

Below the strips, the Staged Output table shows all 13 sections with their current generated DOF strings. As you apply effects to sections, they populate here. Use Generate CSV to export all staged sections, or Clear Session to start over.

Generated DOF String & Export

The Generated DOF String window at the top of the left column shows the live DOF code being built from your active layers. This updates in real time as you adjust any parameter.

Using the Generated String

This string is what you'll paste into the online DOF Config Tool for each table. In the Config Tool, you'll assign this effect string to a specific trigger code (E code) for a specific ROM table. The Config Tool then generates the INI files that the DirectOutput Framework reads on your physical cabinet.

Generated DOF String Workspace

• Add / Copy / Delete act on the currently selected Builder layer tab.
• Layer paging: when more than six layers are present, the Builder shows Prev / Next paging controls so you can move through larger layer stacks without losing the compact panel layout.
• Active segment highlighting: while preview is running, the currently playing slash-delimited chunk(s) of the DOF string are highlighted live so you can see which part of the code is driving the matrix at that moment.
• Resizable height: the window can be vertically resized to expose more or less of the generated code while you work.

Export Options

Send to Code Sim Live Preview

Send to Code Sim copies the Builder's generated DOF string into the Code Sim panel in the Simulator window. This lets you visualize your Builder-designed effect layered over existing effects for example, effects already playing from a loaded ROM table, or over Anim Sim (Pinup Popper menu effects) bitmap output. This is the fastest way to see how your custom effect will look alongside what's already running on the cabinet.

The Code Sim panel uses M/L fire controls plus Loop behavior controls:

DOF JSON Builder Overview

The DOF JSON Builder is the table-specific editing workspace for imported DOF Config Tool JSON files. It combines the same Builder controls used for green-field effect design with trigger-scoped card editing, live preview, and JSON export so you can work on one table at a time without manually copying strings around the online tool.

Think of the JSON Builder as a round-trip editor: export one table from the online DOF Config Tool, import that JSON here, tune or rebuild the effects, export the edited JSON, then re-import it back into the DOF Config Tool.

What This Tab Covers

• What the table JSON contains and where it comes from.
• How the Builder interprets triggers, toys, ports, public/user values, and imported rows.
• Card layout, trigger bars, checkbox line selection, and inline row editing.
• New trigger/effect insertion workflow using + New.
• Category filters for MX, RGB toys, flashers, bumpers, solenoids, and buttons.
• Preview routing for matrix, strips, and toy indicators including pin, strip expansion, trim, and sync.

JSON File Import/Export Process

JSON Table File Explanation

A table JSON is the online DOF Config Tool's export format for one table configuration. It contains the toy list, toy IDs/ports, trigger rows, and the public/user values that make up that table's DOF effects. The JSON Builder reads that data, turns each toy into a card, then exposes each trigger/effect row for scoped editing and preview.

Because the JSON carries table context, toy IDs, and row groupings, it is the safest way to make table-specific edits without manually reconstructing every string from the DOF Config Tool UI.

Export JSON From the Online DOF Config Tool

• Log in to your DOF Config Tool
• Click "Tables-Configurations" in left column, then search for and open the configuration for the table you want to edit.
• You will see two columns: Public Configuration and User Configuration. Public is the baseline table config; User is your editable layer on top of it.
• Click the "More Actions..." button in the upper right.
• Choose "Export User Configuration".
• Choose the export options that match how much of the table you want to work with:

Export Public Configuration	Export only modded toys (sections highlighted in green)	Result
ON	OFF	Exports FULL public AND user configuration
ON	ON	Exports ONLY modded toys with BOTH public AND user entries
OFF	ON	Exports ONLY modded toys with ONLY user entries
OFF	OFF	Exports FULL user configuration WITHOUT public configuration

If you are editing a table for the first time, export the full public + user configuration so the Builder has the complete card set. Once you have an established custom version, exporting only modded toys can produce a tighter editing session focused on the rows you already changed.

Import / Export Inside DOF Pro JSON Builder

Import JSON: click the Import JSON button at the bottom of the Builder window. The file is parsed into cards by toy, with each card showing the toy name and the DOF toy ID (P:###) so you can confirm you are editing the correct destination.

Variable support: JSON rows can preserve variable references and extra tokens. The Builder keeps those intact while still letting you edit the supported DOF parameters through the left-side controls.

Export JSON: once you finish editing, click Export JSON and save the file. That exported file is what you bring back into the online DOF Config Tool.

Import the Edited JSON Back Into the DOF Config Tool

• Log in to your DOF Config Tool.
• Click "Tables-Configurations", search for and open the configuration for the table you want to import to.
• Click the "More Actions..." button in the upper right
• Choose "Import User Configuration"
• Drag and drop or browse for your edited JSON file
• Click the "Import User Configuration" button to import the file
• You will now see the edited toys highlighted in green
Round-trip rule: Builder export produces the JSON that goes back to the Config Tool. The Config Tool then regenerates the DirectOutputConfig*.ini files your cabinet actually runs.

Card UI & Filters

Card Anatomy

Card Drag & Drop

• Drag starts only from the :: grip (prevents accidental drag while editing text).
• Drop reorders cards visually and persists order per table in local storage.
• Category dividers are rebuilt automatically after reorder.

Use Save Table Layout when you want the current card order/geometry to stay with the active table, or Save Global Layout when you want the arrangement to become your default Builder workspace across tables.

Filter Bar

The filter bar can limit both cards and section buttons by category, import delta state, and live edit state.

Use Show empty to include or hide cards with no user effect payload.

Card Controls

Triggers, New Effects & Layer Tools

Line-by-Line Editing

Each row is editable text. To edit existing content:

1. Check the specific row(s) you want to edit.
2. Edit the row text directly in place.
3. Press Enter to commit parse/update.
4. Use per-row preview (>) to validate output before export.

NOTE: Checked rows define what the active section writes back when syncing with Builder controls.

Add New Trigger + Effect

1. Click + New on a card.
2. Choose an existing trigger from dropdown or type a new trigger (for example S2, W45, E112).
3. Build the effect in left-side Builder controls or paste raw line text.
4. Click OK Add Layer to insert into that card.

NOTE: New layers insert after the last layer using that same trigger so trigger groups stay contiguous.

Trigger-Scoped Editing

• Large trigger groups page through tab windows with Next/Prev controls.
• Firing/selecting a trigger in the card trigger bar selects triggered layers and adds check marks.
• Checked lines will be displayed in "Generated DOF String" window and as individual layer tabs.
• NOTE: When adding additional effects to a trigger (for instance, "S4"), it will be better to clear the existing check marks for all "S4" effects BEFORE adding the new "S4" effect. Once the new effect is added, the next time you trigger "S4" from the trigger bar, it will display all effects at once.

Layer Operations in Builder

Within Builder controls, you can manage layers while JSON mode is active:

• Add Layer: appends a new layer tab.
• Copy Layer: duplicates current layer.
• Delete Layer: removes current layer.
• Reset / Revert: per-card and global reset tools are available in filter actions.

Effects Library

The FX button opens the Builder's effects helper/library context for the active card. Use it to browse known effect patterns, copy token combinations, or jump-start a new row before fine-tuning it with the left-side controls.

Variables & Extra Tokens

Rows can preserve and parse extra tokens such as variable references and modifiers, including @name@ and nobool payloads.

Preview Routing & Matrix Controls

Preview Surfaces

• Matrix: primary MX render target.
• Vertical Strips: compact inline rack or extended side layout.
• Toy Icon Bar: non-dimensional toy activity indicators.

Strip Expand / Compact

Use the strip mode toggle to switch between:

• Compact: strips stay inline beside matrix.
• Expanded: strips detach into a full-height side panel for easier monitoring.

Matrix Pin

The Pin control keeps matrix preview fixed at the top while card content scrolls independently. Use this for long-card editing sessions so visual feedback remains constantly visible.

Preview Toolbar Controls

Sync Mode

Per-card Sync check boxes control whether a card participates in linked trigger firing during global sync operations. To enable synced display of linked triggers, the "UNLINK/LINK SYNC" button above the LED matrix must be turned on - (LINK SYNC ON) - when synced, activating a trigger on any card will fire the trigger on all synced cards.

Workflow Guide

The DOF Pro-Series application combines a Simulator (for viewing and testing existing DOF effects) with a Builder (for designing new ones). Together they form a complete workflow for creating, testing, and deploying custom LED effects to your virtual pinball cabinet.

The Four-Step Workflow

Before Step 1: Load the Right Workspace

Use Import DOF Folder to load and classify your standard DOF files from one folder root. If you are continuing a recent session, Resume Last Workspace restores cached files and Builder state. If you are changing cabinets or want a guaranteed clean session, use Start Clean first.

Step 1: Design in the Builder

Open the DOF Builder/JSON Builder and configure your multi-layer effect. Select colors, set timing, add shapes, plasma, bitmap rows, or sparkle. The live matrix preview shows you exactly what the effect will look like on your cabinet's LED panel.

Step 2: Test in the Simulator

View in the Builder interface or click Send to Code Sim to transfer your generated DOF string to the simulator's Code Sim panel. Latch it, enable Loop for timed effects, and verify it renders correctly on the full matrix with your cabinet's actual dimensions and strip configuration.

The Code Sim renders your Builder effect layered over any existing effects already playing in the simulator whether from a loaded ROM table's trigger codes or from Anim Sim bitmap and effects output (Pinup Popper menu effects). This lets you see exactly how your custom effect will interact with what's already running on the cabinet before committing it to your configuration.

Step 3: Deploy via the DOF Config Tool

If using the JSON Builder, you can export directly to JSON for easy import to the online DOF Config Tool, or you can copy the generated DOF string (or export as CSV from the Staged Output) and paste it into the DOF Config Tool section for that toy. Assign it to the correct E code for your target ROM table. The Config Tool generates the INI files that the DirectOutput Framework reads.

Step 4: Play on Your Cabinet

Download the updated INI files from the DOF Config Tool and place them in your DirectOutput configuration folder. Launch the table in your pinball front-end (Pinup Popper, PinballX, etc.) and your custom effect will fire on the physical hardware.

Common Use Cases

Custom Table Effects

Design unique LED effects for specific tables. Instead of using the default DOF effects, create custom multi-layer compositions tailored to each table's theme matching colors, timing, and visual style to the table art and gameplay.

Pinup Popper Menu Effects

The Animation Simulator loads your Pinup Popper menu effects spreadsheet. Use it to preview and modify menu effects then use the Builder to design replacement effects for specific E codes in your effects CSV.

Effect Prototyping

Even without a physical cabinet, you can use the Builder + Simulator to prototype effects. The Code Sim's Loop button makes it easy to iterate on timed effects adjust timing, watch the cycle, refine until perfect.

Sharing with the Community

Export your Staged Output as CSV or JSON and share with other users. They can import your DOF strings or JSON files into their own DOF Config Tool entries. The effects are hardware-independent - they'll render the same on any cabinet with a compatible matrix and toy configuration.

Pro Tips

1. Start with the Base Layer

Build your effect from the bottom up. Layer 1 at Z:0 is usually a solid color fill that covers the whole matrix. Then add overlays shapes, sparkle, scrolling text on higher Z layers.

2. Use Wait (W) for Staggered Reveals

Multi-layer effects with different W values create cascading animations. Three layers with W0, W200, and W400 will appear one after another, each 200ms apart.

3. Test RGB-Only Sections Separately

Remember that RGB-only toys (RGB Flipper, RGB Magnasave, RGB Fire Button, etc.) can only show one color. Design your MX effects first, then set matching accent colors on the RGB sections.

4. Use the Code Monitor for Quick Edits

The simulator's Code Monitor is editable. For small tweaks to an existing table's effects, you can modify the DOF string directly in the monitor and see the result instantly.

5. Loop for Timing Verification

When designing effects with Fade Up/Down timing, always use the Code Sim Loop button to verify the full cycle. What looks good on paper might feel too fast or slow in practice.

6. Use JSON Builder for Table-Specific Round Trips

When you are editing one specific table, export its JSON from the online DOF Config Tool, work in JSON Builder, then export the edited JSON back into the Config Tool. This preserves toy IDs, trigger grouping, and table context much more safely than manual copy/paste alone.

Technical Reference

This section is the complete DOF parameter reference. It is intended as a self-contained resource if you want to understand what any parameter does at the implementation level, you should not need to go anywhere else.

Quick Reference (Builder Controls -> DOF Tokens)

DOF Effect String Format

A DOF output column in the Config INI contains one or more layers separated by forward slashes (/). Each layer is a space-separated sequence of parameters:

        [Trigger] Color [Duration] [AreaParams] [MotionParams] [FadeParams] [BlinkParams] [SparkleParams] [SHPname] [Lx]
    

All parameters except the trigger and color are optional and have defaults. Parameters are case-insensitive. Order within a layer is flexible the parser identifies each parameter by its prefix token.

Trigger Tokens

Color & Intensity

Area Parameters

Motion Parameters

Timing & Duration

Fade Parameters

Blink Parameters

Plasma Parameters

Sparkle / Random Flicker

Shape Sprites

Common shape names include: SHPRoundPulse, SHPSquarePlop, SHPDiamondBoxPulse, SHPArrowLeft, SHPArrowRight, SHPFillLeftRight, SHPFillTopBottom, SHPUpDown, SHPRoundAndRound, SHPLetterAZ, SHPDigit09. Download the shapes files from the Resources section.

Builder Effect Controls Complete Token Map

INI File Structure

DOF configuration INI files use a section-based format. The sections the simulator reads are:

Output Column Mapping

The simulator uses a hybrid sparse/sequential rule to map CSV column index to hardware output number:

• If the table has exactly as many columns as there are assigned WS2811 outputs in Cabinet.xml SPARSE: column N maps to the Nth assigned output number (e.g. outputs at positions 1, 4, 7, 10, 13, 16).
• Otherwise SEQUENTIAL: column N maps to output number N+1.

This correctly handles both the 6-column WS2811 tables that dominate most cabinets and the larger multi-output tables (8, 10, 12 columns) used by tables like Diner, Twilight Zone, etc.

DOF Named Color Palette

All DOF named colors bundled in this app are listed below. Use the exact name (including underscores) in your effect strings. Each swatch shows the rendered color, name, and hex value.

Configuration INI Guide

Filenames do not need to match exactly. The simulator reads each INI by role and validates content.

Each INI contains the standard DOF CSV format under the [Config DOF]section: quoted output headers, then ROM rows with the listed effects.

To determine which "DirectOutputConfig#.ini" file controls which toys - open the file in Notepad, look at the [Config DOF] section, and compare it to the sections below.

Current Ingestion Workflow

1. Use Import DOF Folder to choose the folder root that contains your standard DOF files.
2. The app scans that folder root, classifies the INIs by role, and fills the standard configuration slots automatically.
3. Use Advanced Manual Slots only when you need to replace a missing or mis-matched file manually.
4. Click Confirm Files & Continue once the required inputs are loaded.

Workspace Actions

Role Mapping

Physical Toys (Almost always DirectOutputConfig.ini) drives contactors, flashers, shaker, knocker, and other non-addressable toys.

[Config DOF]
# "Rom","Flipper Left","Flipper Right","Slingshot Right","Slingshot Left","10 Bumper Middle Left","10 Bumper Middle Center","10 Bumper Middle Right","10 Bumper Back Left","10 Bumper Back Center","10 Bumper Back Right","Knocker","Combo1-Bell Large","Combo2-Bell Small","Gear","Shaker","Strobe","Authentic Launch Ball","Start Button","Exit"

RGB Toys (typically DirectOutputConfig2.ini) drives RGB toy channels like undercab and button lighting.

[Config DOF]
# "Rom","RGB Flippers","","","RGB Flippers","","","RGB Left Magnasave","","","RGB Right Magnasave","","","RGB Fire Button","","","RGB Undercab Smart","","","RGB Undercab Smart"

Addressable/MX Toys (typically DirectOutputConfig30/51.ini) drives matrix and strip rendering and is required for table playback.

[Config DOF]
# "Rom","PF Left Effects MX HD","","","PF Left Flashers MX","","","PF Right Flashers MX","","","Combo3-Back Strobe","","","Combo4-Custom MX1","","","PF Right Effects MX HD"

Validation Rules Used by This App

Controller Device IDs

These are the device ID numbers assigned by the online DOF Config Tool, and the controller ID number will be appended to the DirectOutputConfig.ini files you download from the online tool.

For instance:

• "SYSTEM1" uses an LED Wiz and a WS2811 Controller - it will have "DirectOutputConfig2.ini" and "DirectOutputConfig30.ini" configuration files.
• "SYSTEM2" uses an FRDM-KL25Z and a Pinscape controller - it will have "DirectOutputConfig8.ini" and "DirectOutputConfig51.ini" files.

Both system's configuration files will contain the same information.

Toy IDs

All toys have an ID number that is used by the DOF Config Tool to identify the exact toy and to map the effects properly. This tool uses that ID as the "P:###" that is shown on the top of each card in the JSON Builder. This allows you to insure your effects are being routed to the proper toy.

Links & Resources

The following resources are the primary reference points for the DOF ecosystem, virtual pinball software, and LED control. These are the same sources used during development of this simulator.

DOF & Configuration

• DirectOutput Framework GitHub Repository Source code, release notes, and issue tracker for the DOF engine.
• DirectOutput Technical Documentation Official reference documentation for the DOF framework parameters and cabinet XML schema.
• Global DOF Config Tool (VPUniverse) The online configuration tool where your DOF INI files originate. This is where table-specific effects are assigned to solenoid/switch/lamp codes.

Sample Data Files

• Download: DOF Sample Files - Want to get familiar with the workflow before using you own files? Download ours and start playing! Included: Table configuration files, Matrix graphics files, Pinup Menu files and documentation files

Pinup Popper

• Nailbuster.com Pinup Popper Wiki Official documentation for the Pinup Popper front-end loader and menu system used by the Animation Simulator.

Community & Forums

• VPUniverse.com Primary hub for virtual pinball table releases, DOF config downloads, and technical discussion.
• VPForums.org Long-running virtual pinball community forum with extensive DOF and cabinet build documentation.
• Facebook: PinUP Pinball System Community group for Pinup Popper users.
• Facebook: World of Virtual Pinball General virtual pinball builders and players.
• Facebook: VPin Cab Builders Focus on cabinet construction, hardware, and integration.
• Facebook: Virtual Pinball Custom LED Effects (VPCLE) Dedicated to DOF effect authoring and LED customization.

Online Resources

• ARCARC.XMISSION.com Massive collection of pinball machine manuals - great reference for adding effects to switch events!
• Virtual Pinball Machine Build By Walt Ottenad. Start to finish build of a Virtual Pinball Machine. 78 page PDF
• MJRNET.org Extensive documentation of all things Virtual Pinball-related.

Video Tutorials

• YouTube: DOF Pro Simulator 1.1 Operation In-depth walkthrough of first release of the DOF Pro Simulator.
• YouTube: Pinup Menu DOF Effects - Walt Ottenad How to edit your Pinup Menu spreadsheet to add custom effects.
• YouTube: Transform Your vPin HD Matrix - Way of the Wrench Add Jaw-Dropping LED Effects from GIFS!.
• YouTube: Speed Up Your DOF Way of the Wrench Tutorial to speed up DOF effects in Pinup Popper.
• YouTube: DOF Config Tool Tour Terry Red Guided walkthrough of the online DOF Config Tool.

You Tube Channels

• Way of the Wrench Fantastic resource for building your own Virtual Pinball Machine.
• Major Frenchy Virtual Pinball and Arcade building tutorials and tips.
• Rudy's Arcade All about Virtual Pinball.
• Terry Red Prolific creator in the Virtual Pinball world.
• ADC Mobile A little shameless self-promotion. :-)

Acknowledgements

The DOF Pro-Series Simulator would not exist without the work of the following projects, creators, and communities. Their contributions to the virtual pinball ecosystem are the foundation on which this tool was built.