Skip to content

mcj-coder-org/fantasy-rpg-world

Repository files navigation

Fantasy RPG World

A cozy slice-of-life fantasy RPG for mobile and web platforms.

Overview

Fantasy RPG World is a relaxing RPG that emphasizes:

  • Settlement Building - Grow your village from humble beginnings
  • NPC Relationships - Build friendships with unique characters
  • Crafting & Gathering - Master various professions
  • Exploration - Discover secrets in a living fantasy world
  • Light Combat - Adventure with creature companions

Tech Stack

Component Technology
Engine Unity 6
Runtime .NET 10
Language C# 13
Platforms iOS, Android, WebGL

Project Status

Phase: Design Documentation

Currently, this repository contains comprehensive game design documents. Implementation will follow.

Repository Structure

fantasy-rpg-world/
├── docs/
│   ├── design/         # 30 Game Design Documents
│   ├── adr/            # Architecture Decision Records
│   ├── plans/          # Implementation plans
│   ├── playbooks/      # Operational procedures
│   ├── retrospectives/ # Task reviews
│   └── roles/          # AI persona definitions
├── src/                # Source code (coming soon)
├── tests/              # Test projects (coming soon)
├── CLAUDE.md           # AI agent onboarding
├── AGENTS.md           # Agent execution rules
├── CONTRIBUTING.md     # Contribution guidelines
└── SECURITY.md         # Security policies

Design Documents

Key design documents in docs/design/:

Document Description
gdd-overview.md Game vision and pillars
gdd-core.md Core gameplay loops
gdd-classes.md Character classes
gdd-combat.md Combat mechanics
gdd-crafting.md Crafting system
gdd-economy.md Economic design
settlement-building-system.md Settlement mechanics
npc-daily-life-system.md NPC simulation

Getting Started

Development Environment

Recommended: Use the dev container for a consistent, pre-configured environment:

  • VS Code: Install Dev Containers extension, then "Reopen in Container"
  • GitHub Codespaces: Click "Code" → "Create codespace on main"

The devcontainer includes:

  • .NET 10 SDK and Node.js 20+
  • All tooling pre-installed (prettier, markdownlint, husky, etc.)
  • Claude and Codex CLI tools
  • Working bash environment for scripts and git hooks

See .devcontainer/README.md for details.

For Contributors

  1. Read CONTRIBUTING.md for workflow
  2. Check docs/design/ for game design context
  3. See open issues for available tasks

For AI Agents

  1. Complete onboarding in CLAUDE.md
  2. Follow rules in AGENTS.md
  3. Review personas in docs/roles/

Development Workflow

This project uses an issue-driven workflow:

  1. All work tracked via GitHub issues
  2. Feature branches for all changes
  3. PRs require review before merge
  4. Test-driven development mandatory

See AGENTS.md for detailed rules.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for:

  • Code of conduct
  • Development setup
  • Pull request process
  • Coding standards

License

[License TBD]

Links

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors