CursedTomorrow README

README проекта с github.com/AhmadHassan-BTed/CursedTomorrow. Одним файлом markdown: README.md.

Cursed Tomorrow

A platforming descent into the atmospheric unknown.

CI License: MIT Version C++ Raylib


Cursed Tomorrow is not just a game; it is a manifestation of tension and the human struggle against an encroaching, atmospheric darkness. Designed and engineered by Ahmad Hassan (B-Ted), this project serves as a technical showcase of modular C++ game design and atmospheric storytelling through interaction.

Overview • Showcase • Architecture • Systems • Resources • Development

Overview

The core of Cursed Tomorrow lies in its simplicity and the weight of its atmosphere. Every movement, jump, and collision is tuned to resonate with the player's experience of navigating a world that feels both fragile and hostile.

Core Pillars


Visual Showcase

The World of Tomorrow

Main Menu

The gateway into the descent.


Gameplay Level Selection
Gameplay Level Select
Navigating the void. Choosing the path.
Atmosphere Death
Warning You Died
Signs of what's to come. The inevitable end.

Architecture Documentation

The project architecture prioritizes decoupling and clear ownership. It is built to scale from a simple prototype to a complex production-grade game.

High-Level System Flow

graph TD
    subgraph "Engine Loop"
        Main[main.cpp] --> |Initialize| Game[Core::Game]
        Game --> |Frame Start| Input[HandleInput]
        Input --> |Update| Logic[UpdateLevelLogic]
        Logic --> |Physics| Phys[Entities::Character]
        Phys --> |Render| Draw[Draw]
        Draw --> |Frame End| Game
    end

    subgraph "Asset Management"
        Game -.-> |Request| RM[ResourceManager]
        RM --> |Cache/Load| Disk[(Disk Assets)]
    end

Module Relationship

The interaction between modules is strictly managed through the CursedTomorrow namespace.

Module Responsibility Internal Coupling
Core Window lifecycle, state machine, and main loop orchestration. High (Orchestrator)
Entities Individual game actors, physics, and local state. Low (Independent)
Resources Centralized asset caching and memory safety. Zero (Utility)
Config Global constants and engine parameters. Static Only

Internal Systems

Request & Data Flow

The data flow follows a strict unidirectional pattern during the update phase to ensure deterministic behavior.

sequenceDiagram
    participant P as Player
    participant G as Game
    participant C as Character
    participant RM as ResourceManager

    G->>G: HandleInput()
    G->>C: Update()
    C->>C: Move() & Jump()
    C->>C: ApplyGravity()
    G->>G: UpdateLevelLogic()
    G->>C: Draw()
    C->>RM: LoadTextureResource()
    RM-->>C: Texture Data
    C->>G: Render Complete

Repository Structure

.
├── .github/              # CI/CD Workflows & Templates
├── assets/               # Game Resources (Audio, Textures)
│   ├── audio/            # Atmospheric soundscapes
│   └── mainScreen/       # Visual interface components
├── docs/                 # Detailed Technical Documentation
├── include/              # Header Files
│   └── CursedTomorrow/   # Project Namespace
│       ├── Core/         # Engine & State Logic
│       └── Entities/     # Actor definitions
├── src/                  # Implementation Files
├── scripts/              # Automation and build helpers
└── CMakeLists.txt        # Build System Configuration

Development Workflow

The development process is designed to be contributor-friendly while maintaining high engineering standards.

1. Environment Setup

Ensure a C++17 compiler and CMake (3.15+) are installed. Raylib is the primary dependency.

By default, CMake expects Raylib to be installed on the system. To fetch Raylib automatically during configuration, use the -D FETCH_RAYLIB=ON option.

2. Build Pipeline with Automatically Fetched Raylib
# Configure and fetch Raylib automatically
cmake -B build -D FETCH_RAYLIB=ON

# Build the project
cmake --build build --config Release

# Run unit tests
ctest --test-dir build
3. Build Pipeline with System-Installed Raylib

If Raylib is already installed on your system, configure the project without the FETCH_RAYLIB option:

# Configure using the system-installed Raylib package
cmake -B build

# Build the project
cmake --build build --config Release

# Run unit tests
ctest --test-dir build

Technical Pipeline

graph LR
    Code[Code Change] --> Lint[Linting Check]
    Lint --> CMake[CMake Config]
    CMake --> Build[Binary Build]
    Build --> Test[Unit Testing]
    Test --> Deploy[Release Artifact]

Academic Resources

This project is supported by extensive documentation and presentation materials detailing its design and theoretical foundations.

Resource Description Format
SRS Document Software Requirements Specification and Data Structures (DSA) concepts. PDF
DSA Presentation Technical walkthrough of the concepts implemented in Cursed Tomorrow. PPTX

Credits & Vision

This project is a solo endeavor by Ahmad Hassan (B-Ted). It represents a commitment to clean code, intentional design, and the pursuit of digital atmosphere.

New people are welcomed to explore, contribute, and fork. The goal is to build a community around intentional game engineering.


"Tomorrow is coming, but it might be cursed."

CursedTomorrow (AhmadHassan-BTed/CursedTomorrow)

Ищем в базе…

Что это за проект?Cursed Tomorrow — это 2D-платформер в жанре хоррор-выживания и побега, написанный с нуля на C++. Он создан как самостоятельная техническая демонстрация собственного модульного игрового движка и атмосферного сюжета.
Это игра или переиспользуемый движок/библиотека?Это самостоятельная игра со своим игровым ядром на C++ (модули Core, Entities, Resources, Config). Это не универсальный движок, который предназначен для подключения в другие проекты.
Как собрать и запустить игру?Установите компилятор C++17 и CMake 3.15+, затем запустите процесс сборки. Raylib загружается автоматически в ходе сборки.
Нужно ли сначала самому установить Raylib?Нет, Raylib — основная зависимость для отрисовки, но она загружается автоматически в рамках сборки через CMake, так что устанавливать её вручную не нужно.
Есть ли вариант с Docker, если я не хочу настраивать инструменты C++ локально?В списке тем проекта указан Docker, что говорит о возможности сборки и запуска в контейнере наряду с обычной сборкой через CMake. Однако в README не описаны точные команды для Docker.
Для кого, кроме игроков, это предназначено?Проект рассчитан и на игроков, которые ищут атмосферный хоррор-платформер, и на разработчиков и студентов, которых интересует изучение задокументированной модульной архитектуры игры на C++.
Какая архитектура используется в игре внутри?Игра разделена на независимые модули в пространстве имён CursedTomorrow: Core (окно, конечный автомат состояний и управление главным циклом), Entities (объекты и физика, независимы), Resources (централизованное кэширование ресурсов, без связей с другими модулями) и Config (статические глобальные константы).
Есть ли дополнительные учебные материалы помимо кода?Да, в проекте есть документ SRS (спецификация требований к ПО), в котором рассматриваются структуры данных и концепции DSA, а также презентация по DSA, где пошагово разбираются реализованные концепции.
Какие есть похожие проекты?OpenRCT2, openage, luanti, bgfx, TheSimpsonsGameRecomp, GDevelop, re4, WoWee
Размер
34.6 MB
Звёзды
4.9K
Обновлён
КоммитNov 09
Возраст
3 г
Коммиты · 90 дней