Project Structure

Project Structure

A game repo is small — almost everything is content. The engine, editor, and build tooling come from dependencies.

my-game/
  package.json        # depends on @chemicalluck/engine + sim (+ @chemicalluck/config)
  tsconfig.json       # extends @chemicalluck/config/tsconfig/game.json
  sim-env.d.ts        # references the engine's virtual-module types
  index.html          # loads /src/main.tsx
  sim.config.js       # optional build overrides (see [[CLI]])
  src/
    main.tsx          # renders <GameEngine />
    game/
      index.css       # Tailwind entry + theme
      data/*.json     # your world (see [[Authoring Content]])
      components/      # optional game-specific UI (e.g. a custom sidebar)
      extensions/      # optional custom features (see [[Extensions]])

src/main.tsx

The entry point renders the engine. The default sidebar and views are used unless you override them:

import { GameEngine } from '@chemicalluck/engine';
import '~/game/index.css';

createRoot(root).render(<GameEngine />);

GameEngine accepts a config:

interface GameConfig {
  sidebar?: React.ComponentType;              // replace the default sidebar
  views?: ViewsRegistry;                      // register extra views
  persistTransforms?: Transform<unknown, unknown>[];  // redux-persist transforms
}

<GameEngine config={{ sidebar: MySidebar }} />

Path aliases

• ~ → ./src (your game code). Use ~/game/....
• @chemicalluck/engine → the engine. Import runtime pieces from @chemicalluck/engine, deep modules from @chemicalluck/engine/... (e.g. @chemicalluck/engine/components/ui/button).

The src/game/ rule

Keep all game-specific code under src/game/. The engine never imports it — your content reaches the engine through build-time discovery (see Architecture). This separation is the whole point: the same engine powers any game.