Campaign Kit docs
v0.1.0
Get help
● Customize · Your brand

Customization
brand it, extend it.

What you change in the admin per campaign, what you change in the code once, and where the code lives if you want to extend the game.

01Per campaign, in the admin (no code)

  • Colours, background, logo, mascot, tap label, points name: Settings → Branding.
  • Token name, symbol, description, links, jetton master: Settings → Token.
  • Every economy number, upgrade cards, daily streak, referrals, ads: Economy.
  • Quests, puzzles, seasons, pass tiers, events, shop items, fairness rules: their pages.
  • Welcome message and bot: Settings → Launch; bot name and picture in @BotFather.

02Icons and wallet names

  • Mini App wallet icon: replace apps/miniapp/public/icon.png (256×256), or set VITE_APP_ICON_URL. Name in the wallet dialog: VITE_APP_NAME.
  • Admin TON Connect icon: apps/admin/public/icon-180.png. The admin's wallet name is "Campaign Kit Admin" (apps/admin/vite.config.ts).
  • Terms and privacy links in the Mini App manifest: VITE_TERMS_URL, VITE_PRIVACY_URL.
  • Rebuild after any change.

03Story sharing and emoji status

Settings → Branding has two optional fields for Telegram features: Story image URL (https, 1080×1920, used for "Share to Story"; empty hides Story sharing) and Emoji status id (digits of a custom emoji players can set as their Telegram status; empty hides it). Both are saved with the rest of the theme.

04Where to change the code

WhatWhere
Mini App screensapps/miniapp/src/screens/* (play, quests, squad, airdrop, profile), theme in apps/miniapp/src/app/theme.ts
Admin pagesapps/admin/src/pages/*
Achievements, API schemaspackages/shared/src/v2.ts, packages/shared/src/api.ts
Economy defaults for new campaignspackages/shared/src/economy.ts (DEFAULT_ECONOMY)
Anti-bot weightspackages/airdrop/src/signals.ts (RULES)
API routesapps/api/src/routes/*; contract in docs/CONTRACT.md and docs/CONTRACT-V2.md
Databasepackages/db/src/schema.ts; generate a migration with pnpm --filter @kit/db generate, apply with pnpm db:migrate

05Keep the rules when you customise

Do not add anything that sells points, energy, boosts or allocation for Stars, and no paid randomness. Keep the vocabulary to points, rewards and eligibility. Run the tests after every change (Build, tests & checks). Any change to the contract needs a new audit.