Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

- **Multiplayer Virtual World** - Real-time 2D top-down game environment (Grid-Town 64x64 map)
- **Human & AI Coexistence** - Both human players and AI agents can interact in the same world
- **Zone System** - 6 distinct zones: Plaza, North Block, West Block, East Block, South Block, Lake
- **Zone System** - 8 distinct zones: Lobby, Office, Central Park, Arcade, Meeting, Lounge Cafe, Plaza, Lake
- **WebSocket Communication** - Low-latency multiplayer via Colyseus
- **AIC HTTP API** - RESTful API for AI agent integration with interactive docs
- **Proximity Chat** - Chat bubbles appear above entities
Expand All @@ -40,14 +40,16 @@

The game world uses the **Grid-Town** layout - a 64x64 tile map (2048x2048 pixels):

| Zone | Description | Location |
| --------------- | -------------------------------- | ------------ |
| **Plaza** | Central social hub (16x16 tiles) | Center |
| **North Block** | Office area with work facilities | Top |
| **West Block** | Cafe and lounge area | Left |
| **East Block** | Meeting rooms | Right |
| **South Block** | Arcade and recreation | Bottom |
| **Lake** | Water feature (blocked) | Bottom-right |
| Zone | Description | Location | NPCs |
| ---------------- | -------------------------------- | ------------- | ----------------------- |
| **Lobby** | Reception, entrance, info boards | Top-left | Greeter, Security Guard |
| **Office** | Workstations, kanban board | Top-right | PM, IT Support |
| **Central Park** | Green space, benches, signpost | Center | Park Ranger |
| **Arcade** | Game cabinets, prize counter | Middle-right | Game Master |
| **Meeting** | Meeting rooms (Room A, Room C) | Bottom-left | Meeting Coordinator |
| **Lounge Cafe** | Cafe counter, seating, vending | Bottom-center | Barista |
| **Plaza** | Fountain, benches, social hub | Bottom-right | Fountain Keeper |
| **Lake** | Water feature (blocked) | Top-left edge | - |

## Project Structure

Expand Down Expand Up @@ -189,11 +191,34 @@ claude

See [.claude/README.md](.claude/README.md) for detailed installation and usage instructions.

## Map Synchronization

The map system uses a single source of truth with automatic sync to server and client:

```
world/packs/base/maps/grid_town_outdoor.json (Source)
└── node scripts/sync-maps.mjs
├── packages/server/assets/maps/village.json
└── packages/client/public/assets/maps/village.json
```

**After editing the source map:**

```bash
node scripts/sync-maps.mjs # Sync to server/client
pnpm build # Rebuild packages
```

See [Map Sync Process](docs/reference/map-sync-process.md) for detailed documentation.

## Documentation

- [PRD Index](docs/PRD-INDEX.md) - Product Requirements Document
- [Demo Runbook](docs/demo-runbook.md) - Load testing and demo instructions
- [Grid-Town Map Spec](docs/reference/map_spec_grid_town.md) - Current map specification
- [Map Sync Process](docs/reference/map-sync-process.md) - Map synchronization guide
- [AIC Schema](docs/aic/v0.1/aic-schema.json) - JSON Schema for AIC API
- [Claude Commands](.claude/README.md) - Claude Code slash commands guide

Expand Down
24 changes: 24 additions & 0 deletions docs/reference/_archive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Archived Documentation

**Status**: DEPRECATED - Do not use

These documentation files are archived and no longer accurate.

## Current Documentation

Use the following current documents instead:

| Topic | Current Document |
|-------|------------------|
| Map Specification | `../map_spec_grid_town.md` |
| Map Sync Process | `../map-sync-process.md` |

## Archived Files

| File | Reason |
|------|--------|
| `map_spec.md` | Old village map (64x52), superseded by Grid-Town (64x64) |

## Archive Date

February 2026
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The archive date is set to a future date (February 2026). This appears to be a placeholder and should be updated to the current date to accurately reflect when these documents were archived.

File renamed without changes.
Loading
Loading