1
Instant Win or Prize Groups is off
Both must be enabled on the product. With no prize groups there is no result to reveal, so nothing renders. This is the most common cause by a distance.
Documentation
Configure CompKit, Screen by Screen
Everything in CompKit is managed from familiar WordPress screens. This guide walks through every settings area — with real screenshots from the plugin.
- Current version
- v3.0.3
- Released
- 9 August 2026
- Requires WordPress
- 6.0 or newer
- Tested up to
- WordPress 7.0
- Requires PHP
- 7.4 or newer
- Also requires
- WooCommerce + Giveaway for WooCommerce
Two Levels of Control
Where Your Settings Live
CompKit uses a simple two-tier model: set sensible global defaults once, then override per product only where you need to.
Global defaults
In the WordPress admin, open CompKit Game Engine and choose a game. These settings apply to every product that uses that game — theme, buttons, sounds, layout and more.
Per-product overrides
Editing a giveaway product? Open its game tab (e.g. Football) to override the global defaults for that one product. Leave any field blank to inherit the global value.
Quick Start
Get a Game Showing in 3 Steps
1
Enable Instant Win & Prize Groups
In the product's giveaway settings, switch on Instant Win and set up your Prize Groups, so there are prizes for CompKit to reveal.
2
Assign the product to the game category
Add your giveaway product to the game's product category (for example Scratchcard, Football or Spin). This tells CompKit which game to load.
3
Leave it on auto, or use the shortcode
By default the game appears automatically on the order confirmation page. Using a custom Thank You page? Drop the game's shortcode (e.g. [scratchcard] or [football]) anywhere on it — the correct tickets load automatically.
Free Module
Instant Reveal Settings
The free module's settings live under Instant Reveal Settings. Defaults apply to all products unless overridden per-product.
- Reveal Style — choose how the prize is revealed: Gift Box (lid lifts on click), Envelope (flap opens) or Flip Card (3D card flip).
- Primary Colour — ticket badges, gift lid, envelope flap and flip-card face.
- Accent Colour — the reveal instruction text, usually a darker shade of the primary.
- Live Preview — every change updates the before/after preview on the right instantly.
Shortcode: using a custom Thank You page? Drop
[instant_reveal] anywhere on it and the correct tickets load automatically.
Premium Modules
Anatomy of a Game Settings Screen
Every premium game shares the same layout, so once you've learned one you've learned them all.
- Mode selector — some games offer modes (e.g. the Scratch Card's Sums & Symbols vs Classic scratch card).
- Tabs — settings are grouped (Card & Layout, Symbols, Sums, Prize Vault, Modal, Buttons, Sound, Import/Export).
- Layout picker — click a layout thumbnail and the live preview updates instantly.
- Live Preview — a real, dummy-data preview with a Desktop / Mobile toggle.
Every Premium Game
The Same Controls, on Every Game
Every premium game shares the same settings structure — the same tabs, the same colour and artwork controls, the same live preview. Here's all eight.
One consistent settings model across all eight games — learn it once and it applies everywhere.
Pick a Style
Some Games Offer More Than One Mode
A few games can play in more than one style. The Scratch Card is the clearest example — switch its Active Mode at the top of the settings screen and the rest of the tabs adapt to match.
- Sums & Symbols — players match symbols or add numbers up to a winning total on a single themed card.
- Classic scratch card — a grid of panels that scratch off to a straight win or no-win, with your own surface image and colours.
- The mode you pick changes which tabs are shown, so you only ever see the settings that apply.
Tip: set the mode globally for your house style, then override it on a single product for a one-off themed draw.
Make It Yours
Theming & Branding
Every game is built to blend into your store. Match your colours, drop in your own artwork, rename the buttons and toggle sounds — all with a live preview, and never a line of code. The Spin the Wheel screen shows the depth on offer.
- Your brand colours — overlay, popup background, play button and in-game accents each take any CSS colour, including
rgba()for transparency. - Your own artwork — upload background images and, on games like the wheel, per-segment graphics, with adjustable opacity and fit.
- Sponsor advertising boards — brandable boards placed inside the games (trackside, pitch-side and more) you can theme or sell.
- Text & labels — show, hide or replace prize text with an image, and relabel buttons to suit your store.
- Sound — turn in-game sound effects on or off to match the mood.
Worked Example
Two Brands From One Settings Screen
These are the same Prize Grab Claw settings, field for field, on a stock install. Cabinet colour, frame, rail, claw, backdrop and play-button wording are all ordinary settings — and the live preview beside the form shows the result as you go.
Backup & Themes
Import / Export
Every game has an Import / Export tab, at both global and product level. Export writes a small settings file holding that game's entire settings state. Import reads one back.
- Back up before you experiment — a few kilobytes captures a screen carrying hundreds of settings. Restoring is one upload.
- Same file, either level — a theme is not tied to global or per-product. Import it wherever you want it to apply.
- Unknown keys are dropped — a file from an older version cannot inject junk into your settings. A typo’d key vanishes quietly too, so start from an export rather than hand-writing one.
- Settings, not media — where a theme references uploaded artwork it stores a URL. Swap those for your own uploads once the theme is in.
Free theme files: ten ready-made looks across seven games are free to download. Take one as-is, or use it as a starting point. How theme files work →
Phones First
Mobile Settings & the Live Preview
Most entrants play on a phone, but settings screens get used on a monitor. Several games carry a separate mobile value for the sizes and spacing that need one.
- Device twins — the base value stays your desktop number and the mobile half defaults to match it, so nothing changes until you change it. They swap at the breakpoint the game’s layout already uses.
- The Editing switch — tells the preview which half you are working on. If a slider appears to do nothing, check you are not editing the mobile value while looking at desktop — that is the usual answer.
- Desktop / Mobile preview — renders at a real desktop width and scales it into the column, rather than showing a narrow strip and calling it desktop.
- Actual size inspector — opens the game at a true 100%, closable by button, Esc or clicking the backdrop. Scaled previews always flatter your type sizes — use this before you publish.
Quick check: read every label in mobile mode. If you would zoom, it is too small — and long custom button labels are where layouts break first. More on mobile reveals →
Fine Control
Per-Product Overrides
Need one product to look different? Open the game's tab on the product edit screen. Every field shows its inherited global value, with a Use Global button to snap it back at any time.
- Inherit by default — leave a field on its global value, or hit Use Global to reset it.
- Override anything — colours, play-button styling, segments, sizing, sounds, advertising boards, and more.
- Per-campaign branding — perfect for sponsored draws or seasonal themes on a single product.
Tip: set your house style once in the global settings, then only touch per-product overrides for the exceptions.
Reference
Common Settings, Explained
Field names vary slightly per game, but these settings appear across most modules.
| Setting | What it controls |
|---|---|
| Licence key | Activates a premium game. Managed from the main CompKit Game Engine page; validated against your site domain. |
| Active mode | Switches how a game plays where it offers variants (e.g. Scratchcard Sums & Symbols vs Classic scratch card). |
| Overlay | The colour/opacity behind the game popup — accepts any CSS colour value, including rgba() for transparency. |
| Popup background | The background colour of the game modal itself. |
| Play button | Label, width, background colour and text colour of the button shown on the order page. |
| Layout / card layout | Where the game and result list sit (e.g. side panel vs stacked); updates the preview live. |
| Scoreboard / opponent | Game-specific labels such as the Football opponent name shown on the scoreboard. |
| Advertising boards | Brandable images placed in-game (e.g. trackside or pitch-side) — great for sponsors. |
| Sound | Enable or disable in-game sound effects. |
| Import / Export | Copy a game's configuration between sites or back it up. |
| Reset to Defaults | Restores a game's settings to the shipped defaults. Save Settings commits your changes. |
Remember to click Save Settings after editing a global screen. Per-product overrides save with the product (Update).
Troubleshooting
The Game Is Not Showing
Almost every case is one of these five, in roughly this order of likelihood.
2
The product is not in the game’s category
Each game watches its own product category. That is what lets you run a scratch card on one competition and a wheel on another — but a product in no game category loads no game.
3
The module is not enabled or licenced
A premium game loads only when it is switched on, licenced for that site, and actually installed. Check the Games list — each installed module shows its version.
4
The giveaway plugin is missing
CompKit is an add-on. It needs Giveaway for WooCommerce by Flintop — formerly Lottery for WooCommerce. The similarly named plugin by a different developer will not work.
5
You are on a custom Thank You page
Automatic placement targets the standard order confirmation page. On a custom one, drop the game’s shortcode where you want it and the right tickets load automatically.
?
Still stuck
Put a real order through yourself and watch the whole flow — it isolates the step that fails faster than reading settings. Then send us the details.
Licencing
Activating a Premium Game
- Open the main CompKit Game Engine page in your WordPress admin.
- Purchase and enter the licence key for the game you want — there's no checkout on this website.
- The game unlocks straight away once the key is validated — all its settings become editable.
- Validation uses only your licence key and site domain — never customer data. See the Privacy Policy.