trifle-bot-types

TypeScript type definitions for Trifle Bot game state and models.

This package automatically extracts and publishes types from the main Trifle Bot repository, ensuring they stay in sync with the source code.

Installation

npm install trifle-bot-types
# or
yarn add trifle-bot-types

Usage

import { GameState, HexDirection, TeamId, VoteStatus } from 'trifle-bot-types';

// Use the types in your code
const gameState: GameState = {
  snake: {
    body: [],
    currentDirection: 'n',
  },
  // ...
};

Exported Types

Core Types

• HexDirection - Hexagonal grid direction type ('n' | 'ne' | 'se' | 's' | 'sw' | 'nw')
• TeamId - Team identifier type ('A' | 'B' | 'C' | 'D' | 'E' | 'F')
• VoteStatus - Vote status type ('pending' | 'complete' | 'failed' | 'rejected')

Game State Types

• GameState - Complete game state interface
• Snake - Snake game object interface
• HexPosition - Hexagonal grid position interface
• GameConfig - Game configuration interface
• TeamConfig - Team configuration interface
• Vote, Votes - Voting system types
• EatenFruit - Eaten fruit tracking
• DerivedConfig - Derived configuration values
• HexNotationDirection - Hex direction notation

See the source code for the complete list of exported types.

Development

To build the package locally:

cd packages/trifle-bot-types
npm install
npm run build

Publishing

To publish a new version:

cd packages/trifle-bot-types
npm version patch|minor|major
npm publish

License

ISC