Open VTT SDK

This package bundles the TypeScript contracts and validation tooling required to build third-party Open VTT game modules.

Contents

• sdk/ – Core interfaces, entity models, and helper services used by the game runtime.
• validator/ – Laravel validation generator (open-vtt-validate CLI) plus supporting scripts and documentation.
• tsconfig.json – Path mappings you can extend inside your module project to resolve the provided types.

Getting Started

1. Install the SDK:

   npm install @open-vtt/sdk

2. Extend the provided tsconfig so imports like @open-vtt/sdk/types/game/state resolve automatically:

   // tsconfig.json
   {
     "extends": "@open-vtt/sdk/tsconfig.json",
     "compilerOptions": {
       "strict": true
     }
   }

3. Import the types in your module:

   import type { GameState, GamePiece } from '@open-vtt/sdk/types/game/state'
   import { BaseGameRulesModule } from '@open-vtt/sdk/types/game/rules'

4. Generate Laravel validation rules by running the bundled CLI:

npx open-vtt-validate --module test-chess --type RootInterface --project tsconfig.json --out validation.php

Refer to sdk/docs/game-module-sdk.md and validator/docs/laravel-validation.md for complete guidance.