Skip to content

Getting Started

Jump to bottom
Vladyslav Vytrykush edited this page Jul 14, 2026 · 1 revision

Getting Started

Welcome to Adventure-Game! This guide will help you set up the project, build it on your computer, and start exploring the game's features and source code.

Whether you're a player interested in trying the game or a developer looking to contribute, this page will walk you through everything you need to get started.

Table of Contents

Prerequisites

Adventure-Game is written entirely in C++ and does not rely on external game engines or third-party libraries.

Before building the project, make sure you have:

Required

  • C++17 compatible compiler
  • Git
  • A C++ IDE or text editor

Supported Compilers

  • Microsoft Visual C++ (Visual Studio 2022 or newer)
  • GCC 11+
  • Clang 14+

Although older compilers may work, they are not officially tested.

Recommended IDEs

The project can be developed using any modern C++ IDE.

Recommended options include:

  • Visual Studio 2022
  • Visual Studio Code
  • CLion
  • Code::Blocks

Visual Studio is currently the recommended environment for Windows development.

Clone the Repository

Clone the repository using Git:

git clone https://github.com/Perry1231/Adventure-Game.git

Navigate into the project directory:

cd Adventure-Game

Build the Project

Visual Studio

  1. Open the solution (.sln) file if provided.
  2. Select Debug or Release configuration.
  3. Build the project.
  4. Run the executable.

GCC

Compile all source files:

g++ -std=c++17 *.cpp -o Adventure-Game

Clang

clang++ -std=c++17 *.cpp -o Adventure-Game

Run the Game

After a successful build, launch the executable.

On Windows:

Adventure-Game.exe

On Linux or macOS:

./Adventure-Game

When the game starts, you'll be presented with the Main Menu, where you can begin a new adventure or access the available game systems.

First Launch

When launching Adventure-Game for the first time, the typical flow is:

  1. Start a new game.
  2. Create your character.
  3. Enter your character's information.
  4. Receive randomized starting equipment.
  5. Open the main menu.
  6. Explore inventory, equipment, and character statistics.

Depending on your selected profession, your starting weapon and armor may differ.

Main Menu Overview

The current version of Adventure-Game provides several menu options:

Option Description
Start Game Begin a new adventure and create a character.
Load Game Load a previously saved game (framework available).
Save Game Save current progress (framework available).
Character Stats View player attributes and equipped items.
Inventory Manage collected items and equipment.
Settings Configure available game options.
Help Display gameplay instructions and controls.

Project Overview

Adventure-Game is organized around several independent gameplay systems.

Current systems include:

  • Character creation
  • Character statistics
  • Inventory management
  • Equipment management
  • Weapon generation
  • Armor generation
  • Potion system
  • Loot chests
  • Active effects
  • Save/Load framework

These systems communicate through clearly separated classes, making the project easy to understand and extend.

Typical Gameplay Flow

The overall game flow currently follows this structure:

Launch Game
      │
      ▼
Main Menu
      │
      ▼
Start Game
      │
      ▼
Character Creation
      │
      ▼
Generate Starting Equipment
      │
      ▼
Main Game Menu
      │
 ┌────┼───────────────┐
 ▼    ▼               ▼
Stats Inventory    Settings
 │      │
 ▼      ▼
Equip Items
Use Potions
View Equipment

As development continues, additional gameplay systems such as combat, NPC interactions, quests, and exploration will integrate into this flow.

Development Environment

The project is built using modern C++ programming techniques.

Technologies currently used include:

Technology Purpose
C++ Core programming language
STL Standard containers and algorithms
Git Version control
GitHub Repository hosting

No external libraries are currently required.

Repository Structure

A simplified overview of the repository:

Adventure-Game/
│
├── Character
├── Inventory
├── Item
├── Weapon
├── Armory
├── Potion
├── Chest
├── Save
├── Main.cpp
└── README.md

A complete explanation of each directory can be found on the Project Structure page.

Troubleshooting

The project does not compile

Make sure your compiler supports C++17 or newer.

Missing source files

Verify that you cloned the complete repository:

git pull

Build errors

Try performing a clean rebuild.

In Visual Studio:

Build → Clean Solution
Build → Rebuild Solution

Save/Load does not work

The current version contains the save/load framework, but full serialization has not yet been implemented.

This is expected behavior.

Next Steps

Now that you've successfully built the project, continue exploring the documentation:

  • Installation – Platform-specific setup instructions.
  • Project Structure – Repository layout and file organization.
  • Architecture – Learn how the project is designed internally.
  • Character System – Understand player attributes and progression.
  • Inventory System – Explore how items are stored and managed.
  • Development Guide – Learn how to extend the project and contribute.

Need Help?

If you encounter any issues while building or running Adventure-Game:

  • Check the project's GitHub Issues page.
  • Review the documentation in this wiki.
  • Open a new Issue if you discover a bug or have a feature request.

Happy coding, and enjoy exploring Adventure-Game! 🚀

Clone this wiki locally