Skip to content

Comments

Add comprehensive CLAUDE.md documentation#63

Merged
sudo-owen merged 2 commits intomainfrom
claude/claude-md-mm01of2tfnurjcz7-LlEFE
Feb 24, 2026
Merged

Add comprehensive CLAUDE.md documentation#63
sudo-owen merged 2 commits intomainfrom
claude/claude-md-mm01of2tfnurjcz7-LlEFE

Conversation

@sudo-owen
Copy link
Collaborator

Summary

This PR adds a comprehensive CLAUDE.md documentation file that serves as a complete guide to the C.H.O.M.P. (Credibly Hackable On-chain Monster PvP) project. This document is designed to help developers, AI assistants, and contributors quickly understand the codebase structure, architecture, and development workflows.

Key Changes

  • Project Overview: High-level description of C.H.O.M.P. as an on-chain turn-based PvP battling game with extensible battle engine
  • Quick Start Guide: Essential commands for building, testing, and running the project
  • Repository Structure: Complete directory tree with descriptions of all major components (Engine, effects, mons, moves, commit managers, etc.)
  • Architecture Documentation:
    • Core battle flow (matchmaking → battle start → turn loop → resolution)
    • Key interfaces and their purposes (IEngine, IMoveSet, IEffect, IAbility, etc.)
    • Move system design with ATTACK_PARAMS structure
    • Effect system with lifecycle hooks
    • Type system (16 types with effectiveness calculation)
    • Storage architecture patterns (BattleData, MonState, bit-packing, transient storage)
  • Development Conventions:
    • Solidity style guidelines (AGPL-3.0, pragma, imports, constants, move indices)
    • Testing patterns and BattleHelper utilities
    • Procedures for adding new mons, moves, and effects
  • Build & Deploy Pipeline:
    • Python processing scripts for validation and code generation
    • Solidity-to-TypeScript transpiler overview
    • Deployment order and CI/CD information
  • Data Files Reference: CSV file formats for mons, moves, abilities, and types
  • Known Issues & Gotchas: Common pitfalls and edge cases (move forcing switches, effect loops, RNG correlation, etc.)
  • Gas Optimization Notes: Key strategies used throughout the codebase

Notable Details

  • Comprehensive mapping of all 11 mons (Aurox, Ekineki, Embursa, etc.) and their move directories
  • Detailed explanation of commit-reveal scheme for simultaneous moves
  • Clear documentation of storage patterns and gas optimization techniques
  • Practical examples for extending the system (new moves, effects, mons)
  • References to key constants and sentinel values used throughout the codebase

https://claude.ai/code/session_01236TfqgStSXbE3fcp5VAWH

Documents the full codebase structure, architecture, development
workflows, conventions, and key interfaces for the Chomp on-chain
battle engine.

https://claude.ai/code/session_01236TfqgStSXbE3fcp5VAWH
@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for monchain-wiki canceled.

Name Link
🔨 Latest commit b6cd586
🔍 Latest deploy log https://app.netlify.com/projects/monchain-wiki/deploys/699d2355705e5f0008f07c02

Replace hardcoded mon listing with pattern description, add Move
Implementation Patterns (4 tiers), Ability Patterns, Mon Directory
Conventions, expanded effect categories, and CSV-to-code mapping notes.
Documentation now describes generalizable patterns rather than
enumerating every mon, making it easier to onboard new mons/dynamics.

https://claude.ai/code/session_01236TfqgStSXbE3fcp5VAWH
@sudo-owen sudo-owen merged commit 66a27b4 into main Feb 24, 2026
5 checks passed
@sudo-owen sudo-owen deleted the claude/claude-md-mm01of2tfnurjcz7-LlEFE branch February 24, 2026 04:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants