Documentation

CompKit Documentation

Pick a product to see its guide, or search every guide at once. Each one walks through the real WordPress screens, step by step.

CompKit Ticket Machine

Turns a WooCommerce shop into a competition site: numbered tickets, instant win prizes, a skill question and automatic draws when a competition closes.

Find your way

Where everything is

Everything sits under CompKit Ticket Machine in the WordPress admin menu. Competitions are WooCommerce products of the type Competition, so you also edit them under Products.

Competitions
Every competition as a card, with its status, tickets sold and quick actions. The table view adds Start now and End now.
View Details
Open a competition for its status, the full ticket log, winners, a CSV export and Select as a Winner for manual draws.
CompKit Game Engine
Shows which reveal games are switched on. The engine is a separate plugin.
Site credit
Customer balances, activity and withdrawal requests.
Spending limits
Customer spending limits and cool-off breaks.
Settings
Every plugin setting, in a grouped sidebar, with a Find a setting search.
Setup wizard
The header button. Five steps that set the site up and save your first competition as a draft.
Start to finish

Setting up a competition

A competition can go live in about ten minutes: set the site up once, then create each competition as a product and publish it.

Once per site

  • Run the Setup wizard. Basics sets what you call your competitions (competitions, raffles, draws, sweepstakes) and names the list, entry list and dashboard pages to match.
  • In Settings > Getting set up > Basics, check the page that lists competitions, which order statuses count as paid, and whether guests can enter without an account. Guests get no tickets unless guest entry is on.
  • Set the Entry question if UK skill-based entry rules apply to you. It applies to every competition unless a competition sets its own.
  • Check Emails and Email sender, so winner and order emails come from your address.
  • Make sure the Scheduled jobs timer is running. It opens and closes competitions on time and starts the draw.

For each competition

1

Add a product

Products > Add New. Give it a title, description and pictures, and set the product type to Competition.

2

Work through the Competition tab

When (open and close dates; leave the end open for a sell-out), Tickets (on sale, the minimum needed to draw, limits per person and per order), Price, Ticket numbers (picked or random, prefix, letters, lucky dip), Winners (how many, Automatic or Manual draw, one prize per person) and Display.

3

Add the extras you want

Optional tabs: Entry question for this competition only, Ticket bundles (buy 5, 10 or 25 with a discount), Relisting, Instant wins and Prize groups.

4

Publish

It shows as Not open yet until its start date, then Live. Check the front end and the Competitions screen.

Two ways to win

Instant wins or a normal draw

Every competition has a normal draw. Instant wins are an extra layer on top, so the real choice is whether to add them.

Normal draw only

  • A random ticket is drawn when the competition closes.
  • The winner hears by email and on the competition page.
  • Set it up in the Winners section of the Competition tab.
  • Best for big single prizes such as cars, holidays or cash.

Draw plus instant wins

  • Chosen ticket numbers win a prize the moment they are bought. The main draw still happens at the end.
  • The buyer sees it straight away on the thank-you page and in My Account under Instant wins.
  • Open the Instant wins tab, switch on Instant win prizes, add the winning numbers and their prizes, then Update. Random numbers work best, so nobody can aim for a winner.
  • Prizes can be a product, a discount code, site credit or free tickets. With the Game Engine installed, the win is revealed through a game.
Closing and drawing

How draws and winners work

A competition is drawn the moment it closes, but only if it sold at least its minimum tickets. Otherwise it fails and nobody wins.

1

Opening

On its start date the scheduled timer switches it from Not open yet to Live. Start now on the Competitions table does it straight away.

2

Closing

It closes on its end date, when the last ticket sells (if Close the competition when it sells out is on), or when you press End now.

3

The minimum check

If Tickets needed to draw was not reached, the status becomes Missed its minimum and there is no draw.

4

The draw

Automatic picks the winning tickets at random from every valid ticket and emails each winner. Manual waits for you to press Select as a Winner on a ticket in View Details, for a live draw done elsewhere.

5

Announcing

Winner cards appear on the competition page, the winners page and the winners ticker. The winner sees You won; everyone else who entered sees Not this time.

6

Relisting

If Relisting is on, the competition reopens as a new run after it finishes or fails, after the wait you set.

Settings

Settings at a glance

Settings has 25 screens in seven groups. Type into Find a setting to jump to any setting by name. Anything a competition sets on its own product tabs wins over these for that competition.

Getting set up
Basics, ticket numbers and the site-wide entry question.
Competition page
What shows on a competition: the quantity picker, bundles or slider, countdown, progress bar, dates and limits.
Shop and lists
Competition cards, the listing page and the entry lists.
Winners and prizes
Winner cards, the winners page, instant win prizes and discount codes.
Customers
My Account, site credit and spending limits.
Look and feel
Colours, wording and the emails customers get.
Advanced
Scheduled jobs and the other site-wide switches.
Switching over

Moving from Flintop or WPGenie

  • Ticket Machine uses the same data as Flintop's Giveaway for WooCommerce, so a Flintop shop carries straight over: deactivate Flintop, activate Ticket Machine.
  • WPGenie's WooCommerce Lottery competitions are copied across with the Bring them across button in the Setup wizard's Switch over step. WPGenie's own data is never changed.
  • The Game Engine works with all three, so your reveal games keep working whichever you run.
Licence

Trial and licence

  • Install the plugin, then open CompKit Ticket Machine > Licence and press Start a free 7-day trial.
  • Keep it with a licence for £14.99 a month or £149 a year. Buy it from the same Licence screen and the key goes in by itself.
  • More on the Ticket Machine page and pricing.

CompKit Game Engine

Reveal games for instant wins on Flintop's Giveaway for WooCommerce or WPGenie's WooCommerce Lottery. Instant Reveal is free; each other game has its own licence.

Current version
v3.0.81
Released
9 October 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 or WooCommerce Lottery
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.

CompKit Instant Reveal Settings admin screen showing reveal style options Gift Box, Envelope and Flip Card, colour pickers and a live preview Instant Reveal global settings with the colour pickers and live before-and-after preview Instant Reveal settings inside a single WooCommerce product, overriding the global defaults The Instant Reveal gift box on a customer's order confirmation page, ready to be opened The Instant Reveal prize result after the gift box has been opened Reveal styles
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.
The full Scratch Card global settings with the live preview on mobile layout — the game shown phone-sized CompKit Scratch Card global settings showing the Active Mode selector, grouped settings tabs, a card-layout picker and a live preview panel Mobile preview
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 — at store level and on any single product. Here's all nine.

One consistent settings model across all nine games — learn it once and it applies everywhere.

CompKit Scratch Card global settings in Classic mode: the Active Mode selector set to Standard - Classic scratch card, surface and card-grid controls, and a live preview of a cloud-themed scratch grid Scratch Card global settings showing the card, symbols and prize vault controls Scratch Card global settings continued, covering the modal, buttons and sound options Classic mode Scratch Card settings on a single WooCommerce product Classic mode
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.
CompKit Spin the Wheel settings showing segment text controls, segment borders and background image options with a live wheel preview Grab Claw settings themed as Galaxy Grab with a deep-space cabinet and neon green claw The same Grab Claw settings themed as Candy Catcher in pastel pink Scratch Card settings with a Volcano Scratchcards theme applied Darts settings with a custom pirate dartboard and dagger uploaded Spin the Wheel
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.

Prize Grab Claw global settings themed as Galaxy Grab: a black cabinet with acid-green accents, an Abduct Aliens play button, and a live preview showing a spaceship claw over a planet full of alien toys
Galaxy GrabBlack cabinet, acid-green rail and claw, a deep-space backdrop and an “Abduct Aliens” button.
The identical Prize Grab Claw settings screen themed as Candy Catcher: a pastel pink cabinet with rounded corners, a Catch Candy play button, and a live preview of a sweet-shop claw machine
Candy CatcherThe same fields, pastel pink, rounded corners and a “Catch Candy” button. Nothing was rebuilt.
The full Prize Grab Claw global settings with the live preview on mobile layout — the game shown phone-sized Grab Claw HUD and header settings controlling the ticket counter, remaining-plays label and on-screen text Mobile preview
HUD & headerControls the ticket counter, the “plays left” label and every other piece of on-screen text.
The full Prize Grab Claw settings inside a giveaway product with the live preview on mobile layout — the game shown phone-sized Grab Claw Modal tab settings for the popup background, overlay colour and sizing Mobile preview
Modal tabSets the popup background, the dimmed overlay behind it and how the game is sized on each device.
The Scratch Card global settings screen with the Import / Export tab available alongside the other setting tabs The same Import / Export control inside a giveaway product, so a theme file can be applied to one competition only Slot Machine settings after importing a theme file, with the live preview showing the result Import / Export tab
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 →
A game settings screen with the live preview switched to mobile layout, showing the game at phone proportions beside the form The same settings screen with the live preview switched to desktop layout Football settings with the preview in mobile mode, used to check the game at phone size before publishing Mobile preview
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 →
A real WooCommerce product edit screen with the Spin the Wheel tab open: each override field has a Use Global button to fall back to the global default, alongside the CompKit Licencing panel in the sidebar Scratch Card settings on a single product, overriding the global defaults with a gold and black theme A product-level override panel showing inherited global values with Use Global reset buttons Slot Machine per-product settings on the product edit screen Instant Reveal per-product settings on the product edit screen Spin the Wheel
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.

SettingWhat it controls
Licence keyActivates a premium game. Managed from the main CompKit Game Engine page; validated against your site domain.
Active modeSwitches how a game plays where it offers variants (e.g. Scratchcard Sums & Symbols vs Classic scratch card).
OverlayThe colour/opacity behind the game popup — accepts any CSS colour value, including rgba() for transparency.
Popup backgroundThe background colour of the game modal itself.
Play buttonLabel, width, background colour and text colour of the button shown on the order page.
Layout / card layoutWhere the game and result list sit (e.g. side panel vs stacked); updates the preview live.
Scoreboard / opponentGame-specific labels such as the Football opponent name shown on the scoreboard.
Advertising boardsBrandable images placed in-game (e.g. trackside or pitch-side) — great for sponsors.
SoundEnable or disable in-game sound effects.
Import / ExportCopy a game's configuration between sites or back it up.
Reset to DefaultsRestores 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.

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.

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 one of two competition plugins: Giveaway for WooCommerce by Flintop — formerly Lottery for WooCommerce — or WooCommerce Lottery by WPGenie with its Pick Number add-on. CompKit detects which one is running and shows it in its dashboard header. What it adds on WPGenie.

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

  1. Open the main CompKit Game Engine page in your WordPress admin.
  2. Purchase and enter the licence key for the game you want — there's no checkout on this website.
  3. The game unlocks straight away once the key is validated — all its settings become editable.
  4. Validation uses only your licence key and site domain — never customer data. See the Privacy Policy.

CompKit Themes and CompKit Extra

A fast theme for UK prize competition sites, and its plugin with live draws, winners, compliance, policies and one-click demo looks.

Getting started

Installing CompKit Themes and CompKit Extra

The theme sets the look. CompKit Extra is its plugin: the extra features and the one-click demo looks.

1

Install the theme

Appearance > Themes > Add New > Upload Theme, choose compkit-themes.zip, then Activate.

2

Install CompKit Extra

Plugins > Add New > Upload Plugin, choose compkit-extra.zip, then Activate.

3

Run the setup wizard

CompKit Extra > Setup wizard walks you through your business details and the pages a competition site needs.

4

Add your licence

Paste your CompKit Themes key under CompKit Extra > Licence to switch on everything else, demo looks included.

Your look

Changing colours, cards and countdowns

Everything visual lives in Appearance > Customize > CompKit Themes. Layout, typography and the rest are in the usual Customizer sections.

  • Competition cards: image-first, with a live countdown, a ticket price tag, a sold bar and a big Enter button.
  • Home page pieces: a hero carousel, a winners ticker and category tabs.
  • Built for CompKit Ticket Machine. Without it the cards still style your WooCommerce products; the countdown, sold bar and ticket options appear when Ticket Machine is active.
  • Shortcodes you can drop on any page: [compkit_hero], [compkit_ticker], [compkit_grid] and [compkit_free_entry]. They always work, licence or not.
CompKit Extra

What CompKit Extra adds

Every part has its own on/off switch under CompKit Extra > Modules.

Free, no key needed

  • Terms and policies: your business details kept once and filled into your own policy wording, with policy pages and footer links. No legal wording is included.
  • Compliance: age check, a cookie banner that holds back tracking until it is accepted, odds on each competition and a postal entries log.
  • Setup wizard.

With a CompKit Themes licence

  • Live draws: a small player on every page while you stream on YouTube or Facebook, a next-draw countdown and a results page.
  • Winners wall: winner photos and a line from each winner.
  • Notify me, Refer a friend (paid as site credit), Recent entries and Basket reminders.
  • Sales dashboard: sold, pace and projected sell-out per competition.
  • Demo packs: the one-click demo looks.
Demo looks

Importing a demo look

A demo pack is a complete example site: competitions, prize pictures, pages, menus, game looks and theme settings.

1

Open the demo packs

CompKit Extra > Modules, Demo packs. Every look is listed with a preview. You can see them all on the demos.

2

Press Import

The pictures download from the CompKit media host during the import, so the plugin itself stays small.

3

Make it yours

Swap the example competitions, prizes and wording for your own, then set your colours in the Customizer.

Licence

Licence and updates

  • A CompKit Themes licence is £79 a year, or £199 a year bundled with Ticket Machine. Buy it from CompKit Extra > Licence and the key is saved for you.
  • The key is checked when you save it and twice a day after that. Only the key, your domain and the plugin version are sent.
  • If a licence lapses, every setting is kept and those parts start again when it is renewed.
  • Updates show under Plugins like any other update. More on the Themes page and the Extra page.
Still stuck?

We Will Help You Set It Up

Send us a message and we will point you to the right screen, or set it up with you.