66This is part of the P(Doom) project ecosystem consisting of three repositories:
77
88### [ DATA] [ pdoom-data] ( https://github.com/PipFoweraker/pdoom-data )
9- ** Historical Events Database**
10- - 28+ real AI safety events (2016-2025)
11- - Game mechanics data and impacts
9+ ** AI Safety Data Lake & Timeline Events**
10+ - 1,028 timeline events (28 curated + 1,000 alignment research)
11+ - Three-zone data architecture (raw → transformed → serveable)
12+ - Automated data pipeline with validation
13+ - Interactive event browser tool
1214- JSON exports for integration
1315- ASCII-only content for agent compatibility
1416
1517** Key Files:**
16- - ` event_data_structures.py ` - Core data types
17- - ` *_events.py ` - Event categories (funding, technical, organizational, institutional)
18- - ` game_integration_helpers.py ` - Game logic utilities
19- - ` data/events/*.json ` - Exported data formats
20-
21- ### [ WEB] [ pdoom-website] ( https://github.com/PipFoweraker/pdoom-website )
22- ** Public Website**
23- - Event timeline displays
18+ - ` data/serveable/api/timeline_events/ ` - Production-ready event data
19+ - ` tools/event_browser.html ` - Interactive event browser (open in browser)
20+ - ` config/schemas/event_v1.json ` - Timeline event schema
21+ - ` scripts/transformation/ ` - Data pipeline scripts
22+ - ` docs/QUICK_START_INTEGRATION.md ` - Integration guide
23+
24+ ### [ WEB] [ pdoom-website] ( https://github.com/PipFoweraker/pdoom-website )
25+ ** Public Website & API**
26+ - Event timeline displays with interactive browser
2427- Game information and downloads
2528- Documentation and guides
26- - Community engagement
29+ - Community engagement and player feedback
30+ - PostgreSQL + FastAPI backend
2731
2832** Integration Points:**
29- - Consumes JSON exports from pdoom-data
33+ - Imports timeline events from pdoom-data to PostgreSQL
3034- Displays interactive event timelines
31- - Links to game scenarios
32- - Provides public API endpoints
35+ - Player feedback system (quarantined submissions)
36+ - RESTful API endpoints for events and metadata
37+ - Embeds event browser for community review
3338
3439### [ GAME] [ pdoom1] ( https://github.com/PipFoweraker/pdoom1 )
35- ** Strategy Game**
40+ ** Strategy Game (Godot) **
3641- Interactive P(Doom) simulation
37- - Historical event integration
42+ - Historical event integration (1,028 events)
3843- Player choice mechanics
44+ - Dynamic timeline system
3945- Save/load game states
4046
4147** Integration Points:**
42- - Imports event modules from pdoom-data
43- - Processes historical events in gameplay
48+ - Loads timeline events from pdoom-data JSON files
49+ - Processes event impacts on game variables
4450- Tracks player interactions with events
45- - Provides gameplay analytics
51+ - Uses event metadata for game mechanics (rarity, player_choice, impact_level)
52+ - Provides gameplay analytics back to website
4653
4754## INTEGRATION ARCHITECTURE
4855
4956```
5057pdoom-data (Source of Truth)
5158 |
52- |-- JSON Exports --> pdoom-website (Display)
53- | |
54- | v
55- | Public API
56- |
57- |-- Python Modules --> pdoom1 (Gameplay)
58- |
59- v
60- Analytics
59+ |-- Data Pipeline --> Serveable Zone (1,028 events)
60+ | |
61+ | |-- JSON --> pdoom1 (Godot Game)
62+ | | |
63+ | | v
64+ | | Gameplay & Analytics
65+ | |
66+ | |-- Import --> pdoom-website (PostgreSQL)
67+ | |
68+ | v
69+ | Public API & Event Browser
70+ | |
71+ | v
72+ | Player Feedback (Quarantined)
73+ | |
74+ | v
75+ | Community Metadata Layer
6176```
6277
6378## DEVELOPMENT STANDARDS
@@ -87,19 +102,41 @@ When working on any P(Doom) repository:
87102
881031 . ** Check related repos** for existing implementations
891042 . ** Maintain ASCII-only** content everywhere
90- 3 . ** Follow data schemas** defined in pdoom-data
105+ 3 . ** Follow data schemas** defined in pdoom-data ( ` config/schemas/event_v1.json ` )
911064 . ** Update integration docs** when making changes
921075 . ** Test cross-repo** functionality
108+ 6 . ** Use Event Browser** (` tools/event_browser.html ` ) to review events interactively
109+
110+ ### Key Documentation Locations
111+
112+ ** pdoom-data** :
113+ - Integration: ` docs/QUICK_START_INTEGRATION.md `
114+ - Event Schema: ` docs/EVENT_SCHEMA.md `
115+ - Event Browser: ` docs/EVENT_BROWSER_GUIDE.md `
116+ - Architecture: ` docs/DATA_ZONES.md `
117+ - All Docs: ` docs/DOCUMENTATION_INDEX.md `
118+
119+ ** pdoom-website** :
120+ - API Documentation (check repo)
121+ - Feedback Integration Guide (check repo)
122+
123+ ** pdoom1** :
124+ - Event System Documentation (check repo)
125+ - Game Integration Guide (check repo)
93126
94127### Navigation Commands
95128``` bash
96129# Clone all related repositories
97130git clone https://github.com/PipFoweraker/pdoom-data.git
98- git clone https://github.com/PipFoweraker/pdoom-website.git
131+ git clone https://github.com/PipFoweraker/pdoom-website.git
99132git clone https://github.com/PipFoweraker/pdoom1.git
100133
101- # Validate ASCII compliance across all repos
102- find . -name " *.py" -o -name " *.md" | xargs python validate_ascii.py
134+ # Open Event Browser
135+ cd pdoom-data
136+ # Then open tools/event_browser.html in your browser
137+
138+ # Load event data
139+ # In browser: load data/serveable/api/timeline_events/all_events.json
103140```
104141
105142## DATA FLOW PATTERNS
@@ -124,24 +161,37 @@ find . -name "*.py" -o -name "*.md" | xargs python validate_ascii.py
124161
125162## COMMON TASKS
126163
127- ### Adding New Historical Event:
128- 1 . ** In pdoom-data** : Add to appropriate ` *_events.py ` file
129- 2 . ** Test locally** : Run ` python setup_clean.py `
130- 3 . ** Commit changes** : Triggers sync to other repos
131- 4 . ** Update website** : Event appears in timeline
132- 5 . ** Update game** : Event available in gameplay
133-
134- ### Updating Game Mechanics:
135- 1 . ** In pdoom-data** : Modify ` game_integration_helpers.py `
136- 2 . ** Update schema** : Increment version if breaking
137- 3 . ** In pdoom1** : Update integration code
138- 4 . ** Test compatibility** : Ensure old saves work
139-
140- ### Website Content Updates:
141- 1 . ** In pdoom-website** : Update display components
142- 2 . ** Test with real data** : Use pdoom-data JSON exports
143- 3 . ** Verify mobile** : Responsive design
144- 4 . ** Update documentation** : Cross-repo impact
164+ ### Adding New Timeline Event:
165+ 1 . ** In pdoom-data** : Add to ` data/raw/events/*.json `
166+ 2 . ** Run pipeline** : ` python scripts/transformation/clean.py && python scripts/transformation/transform_to_timeline_events.py `
167+ 3 . ** Review in browser** : Open ` tools/event_browser.html ` and load the event
168+ 4 . ** Add metadata** : Tag impact level, game relevance, etc.
169+ 5 . ** Commit changes** : Triggers automated pipeline (GitHub Actions)
170+ 6 . ** Update website** : Re-import events to PostgreSQL
171+ 7 . ** Update game** : Copy new JSON to game data folder
172+
173+ ### Reviewing Large Event Datasets:
174+ 1 . ** Open browser** : ` tools/event_browser.html `
175+ 2 . ** Load events** : Select JSON file from ` data/serveable/api/timeline_events/ `
176+ 3 . ** Use filters** : Category, year range, search text
177+ 4 . ** Annotate events** : Add impact level, game relevance, notes
178+ 5 . ** Export metadata** : Download ` *_metadata.json ` file
179+ 6 . ** Commit metadata** : Store in version control for team review
180+
181+ ### Integrating Player Feedback (Website):
182+ 1 . ** Design feedback form** : Capture event ID, suggested changes, rationale
183+ 2 . ** Create API endpoint** : ` POST /api/events/feedback `
184+ 3 . ** Quarantine submissions** : Store in ` data/feedback/pending/ `
185+ 4 . ** Review in browser** : Load feedback alongside events
186+ 5 . ** Approve feedback** : Move to ` approved/ ` and update community metadata
187+ 6 . ** Display on website** : Show community notes on event pages
188+
189+ ### Updating Event Schema:
190+ 1 . ** Modify schema** : ` config/schemas/event_v1.json `
191+ 2 . ** Update documentation** : ` docs/EVENT_SCHEMA.md `
192+ 3 . ** Test pipeline** : Ensure validation passes
193+ 4 . ** Update cross-repo code** : pdoom1, pdoom-website
194+ 5 . ** Version bump** : Increment schema version if breaking
145195
146196## TROUBLESHOOTING
147197
@@ -173,13 +223,40 @@ For questions about:
173223
174224## VERSION COMPATIBILITY
175225
176- Current stable versions:
177- - pdoom-data: v1.0.0
226+ Current versions:
227+ - pdoom-data: v0.2.0 (In Development)
228+ - Event Schema: v1.0.0
178229- pdoom-website: (check repo)
179230- pdoom1: (check repo)
180231
181232Compatibility matrix and migration guides available in each repository's docs/ folder.
182233
234+ ## TOOLS & UTILITIES
235+
236+ ### Event Browser (` tools/event_browser.html ` )
237+ ** Purpose** : Interactive browser for reviewing and annotating events
238+ ** How to use** :
239+ 1 . Open HTML file in browser
240+ 2 . Load events JSON
241+ 3 . Browse, filter, annotate
242+ 4 . Export metadata
243+
244+ ** Use cases** :
245+ - Review large event datasets
246+ - Tag events for game integration
247+ - Community feedback review
248+ - Quality assurance checks
249+
250+ See ` docs/EVENT_BROWSER_GUIDE.md ` for complete documentation.
251+
252+ ### Data Pipeline Scripts (` scripts/ ` )
253+ - ` transformation/clean.py ` - Clean and normalize data
254+ - ` transformation/enrich.py ` - Add derived fields
255+ - ` transformation/transform_to_timeline_events.py ` - Convert to timeline format
256+ - ` validation/validate_alignment_research.py ` - Validate schema compliance
257+ - ` publishing/generate_manifest.py ` - Create data catalog
258+ - ` analysis/event_impact_manager.py ` - CLI tool for event management
259+
183260---
184261
185262** Remember** : This ecosystem is designed for agent-based development.
0 commit comments