README.md

simullm

Event-driven Agent-Based Modeling framework for TypeScript.

📦 Package

The main package is located in packages/simullm/ - see its README for full documentation, API reference, and usage examples.

Quick install:

npm install simullm
# or
bun add simullm

🏗️ Repository Structure

This is a monorepo containing:

.
├── packages/
│   └── simullm/           # 📦 Main package - Event-driven ABM framework
│       ├── lib/           # Core library code
│       ├── experiments/   # Example simulations
│       └── scripts/       # Release automation

🚀 Quick Start

import { createSimulation, createAgent } from "simullm";

const simulation = createSimulation({
  initialGlobalState: { value: 0 },
  agents: [myAgent],
  shouldExit: ({ actionCount }) => actionCount >= 10, // Required in v0.2.0+
});

await simulation.dispatch({ type: "START" });

📚 Documentation

• Full Documentation - Complete usage guide and API reference
• Examples - Counter, ecosystem, and market simulations
• Changelog - Version history and breaking changes

🛠️ Development

This workspace uses Bun:

# Install dependencies
bun install

# Run tests for the main package
cd packages/simullm && bun test

# Release new version
cd packages/simullm && bun run release

📄 License

MIT