Chrono Crusaders Documentation

Welcome to the Chrono Crusaders project documentation. This guide provides an overview of the project's structure, codebase, and assets to help you navigate and contribute effectively.

Table of Contents

1. Introduction
2. Project Structure
3. Assets
4. Codebase
5. Documentation
6. Contributing
7. License

Introduction

Welcome to the Chrono Crusaders project! This section provides an overview of the game and its goals.

Back to Table of Contents

Complete Project Structure

ChronoCrusaders/
├── assets/
│   ├── audio/
│   ├── sprites/
│   │   ├── players/
│   │   ├── enemies/
│   │   ├── items/
│   │   └── tilesets/
│   ├── icons/
│   └── fonts/
├── maps/
│   ├── generated/
│   ├── templates/
│   └── map_generator.py
├── scenes/
│   ├── main_menu.tscn
│   ├── gameplay.tscn
│   ├── pause_menu.tscn
│   └── game_over.tscn
├── src/
│   ├── core/
│   │   ├── game_controller.py
│   │   └── entity_handler.py
│   ├── entities/
│   │   ├── player.py
│   │   ├── enemy.py
│   │   └── item.py
│   ├── systems/
│   │   ├── ai_system.py
│   │   ├── inventory_system.py
│   │   └── combat_system.py
│   ├── utilities/
│   │   ├── math_utils.py
│   │   └── file_utils.py
│   └── config/
│       ├── game_settings.json
│       └── controls.json
├── scripts/
│   ├── map_scripts.py
│   └── asset_importer.py
├── docs/
│   ├── design.md
│   ├── architecture.md
│   └── user_manual.md
├── .gitignore
├── .gitattributes
├── README.md
└── project.godot

Breakdown of the file Structure

Assets

ChronoCrusaders/
├── assets/
│   ├── audio/
│   ├── sprites/
│   │   ├── players/
│   │   ├── enemies/
│   │   ├── items/
│   │   └── tilesets/
│   ├── icons/
│   └── fonts/

assets/: Contains all media assets used in the game.

• audio/: Contains sound effects and background music files.

  • Files: Typically .wav, .mp3

• sprites/: All sprite images, organized into subdirectories:

  • players/: Sprites for player characters.
  • enemies/: Sprites for enemy characters.
  • items/: Sprites for items.
  • tilesets/: Tilesets used for creating maps.

• icons/: Icons used in UI and other parts of the game.

• fonts/: Fonts used throughout the game. Back to Table of Contents

Maps

ChronoCrusaders/
├── maps/
│   ├── generated/
│   ├── templates/
│   └── map_generator.py
├── scenes/
│   ├── main_menu.tscn
│   ├── gameplay.tscn
│   ├── pause_menu.tscn
│   └── game_over.tscn

maps/: Contains map-related files and scripts for procedural map generation.

• generated/: Directory for maps that are dynamically generated during gameplay.

  • Purpose: Stores maps created on-the-fly based on game logic or user actions.

• templates/: Contains map templates and layout definitions.

  • Purpose: Holds predefined map layouts and configurations that can be used as a basis for generated maps or manually designed levels.

• map_generator.py: Script for procedural map generation.

  • Purpose: Contains the logic and algorithms used to generate maps dynamically during gameplay.

Back to Table of Contents

Codebase

ChronoCrusaders/
├── src/
│   ├── core/
│   │   ├── game_controller.py
│   │   └── entity_handler.py
│   ├── entities/
│   │   ├── player.py
│   │   ├── enemy.py
│   │   └── item.py
│   ├── systems/
│   │   ├── ai_system.py
│   │   ├── inventory_system.py
│   │   └── combat_system.py
│   ├── utilities/
│   │   ├── math_utils.py
│   │   └── file_utils.py
│   └── config/
│       ├── game_settings.json
│       └── controls.json
├── scripts/
│   ├── map_scripts.py
│   └── asset_importer.py
├── docs/
│   ├── design.md
│   ├── architecture.md
│   └── user_manual.md
├── .gitignore
├── .gitattributes
├── README.md
└── project.godot

src/: Contains the source code for the game.

• core/: Core game logic files.

  • game_controller.py: Manages overall game state.
  • entity_handler.py: Handles entities (players, enemies, items).

• entities/: Definitions for various game entities.

  • player.py: Player class and related logic.
  • enemy.py: Enemy class and related logic.
  • item.py: Item class and related logic.

• systems/: Game systems for AI, inventory, and combat.

  • ai_system.py: AI logic for enemies.
  • inventory_system.py: Manages item inventories.
  • combat_system.py: Handles combat mechanics.

• utilities/: Utility scripts and helpers.

  • math_utils.py: Mathematical utilities.
  • file_utils.py: File handling utilities.

• config/: Configuration files.

  • game_settings.json: General game settings.
  • controls.json: Player control mappings.

• docs/: Contains documentation related to the project.

  • design.md: Design documents outlining the game's design principles and considerations.
  • architecture.md: Architecture overview detailing the system design and structure.
  • user_manual.md: User manual providing instructions and information for end-users.

Back to Table of Contents