Skip to content

Installation

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

Installation

This page provides detailed instructions for installing, building, and running Adventure-Game on different operating systems and development environments.

Adventure-Game is a lightweight C++ console application that uses only the C++ Standard Library (STL). No external frameworks, game engines, or third-party dependencies are required.

Table of Contents

System Requirements

Adventure-Game has very low hardware requirements since it is a console-based application.

Minimum Requirements

Component Requirement
Operating System Windows 10, Windows 11, Linux, or macOS
Processor Any modern x64 CPU
RAM 2 GB
Storage Less than 100 MB
Compiler C++17 compatible

Recommended Requirements

Component Recommendation
Operating System Windows 11
RAM 4 GB or more
Compiler Latest Visual Studio, GCC, or Clang
Git Latest version

Supported Platforms

Adventure-Game is designed to be cross-platform.

Platform Status
Windows ✅ Fully Supported
Linux ✅ Supported
macOS ✅ Supported
ARM Devices ⚠ Not officially tested

Although the project is intended to compile on multiple platforms, most development is currently performed on Windows using Visual Studio.

Requirements

Before building Adventure-Game, install the following software.

Required

  • Git
  • C++17 compatible compiler

Optional

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

Installing Git

Download and install Git from the official website:

https://git-scm.com/

Verify the installation:

git --version

Example output:

git version 2.xx.x

Cloning the Repository

Clone the latest version of Adventure-Game.

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

Navigate into the project folder:

cd Adventure-Game

To update an existing clone:

git pull

Building with Visual Studio

Visual Studio is the recommended IDE for Windows development.

Step 1

Open the solution file:

Adventure-Game.sln

If no solution file is available, create a new C++ Console Project and add the existing source files.

Step 2

Choose one of the available configurations:

  • Debug
  • Release

Step 3

Select the target platform.

Typically:

x64

Step 4

Build the solution.

Menu:

Build
→ Build Solution

Shortcut:

Ctrl + Shift + B

Step 5

Run the project.

Menu:

Debug
→ Start Without Debugging

Shortcut:

Ctrl + F5

Building with GCC

Compile all source files:

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

If your project contains multiple directories, include the required source files:

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

Building with Clang

Compile using Clang:

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

Running the Game

Windows

Adventure-Game.exe

Linux

./Adventure-Game

macOS

./Adventure-Game

Build Configurations

Debug

Recommended while developing.

Advantages:

  • Easier debugging
  • Better error messages
  • Debug symbols enabled

Release

Recommended for normal gameplay.

Advantages:

  • Faster execution
  • Compiler optimizations
  • Smaller executable

Recommended Development Tools

Although any editor can be used, the following environments provide the best experience.

IDE Recommended Notes
Visual Studio 2022 ⭐⭐⭐⭐⭐ Best Windows experience
Visual Studio Code ⭐⭐⭐⭐ Lightweight with C++ extension
CLion ⭐⭐⭐⭐ Excellent CMake support
Code::Blocks ⭐⭐⭐ Good beginner IDE

Project Dependencies

Adventure-Game intentionally avoids external dependencies.

The project currently relies only on:

  • C++ Standard Library
  • Compiler runtime

No installation of SDL, SFML, OpenGL, DirectX, Boost, or other libraries is required.

Verifying the Installation

If everything is configured correctly, launching the executable should display the game's main menu.

Example:

===============================
       Adventure Game
===============================

1. Start Game
2. Load Game
3. Save Game
4. Character Stats
5. Inventory
6. Settings
7. Help

Choose an option:

If you see a similar menu, the installation was successful.

Common Installation Problems

C++17 Not Supported

Error example:

error: unknown standard 'c++17'

Solution:

Update your compiler to a newer version.

Command Not Found

'g++' is not recognized...

Solution:

Install GCC or add it to your system PATH.

Missing Source Files

If compilation fails because files cannot be found:

git pull

Ensure the repository cloned successfully.

Executable Closes Immediately

Run the executable from a terminal instead of double-clicking it.

Alternatively, run using:

Adventure-Game.exe

inside Command Prompt or PowerShell.

Save & Load Does Not Work

The Save and Load interface is currently present, but full serialization functionality has not yet been implemented.

This is expected and does not indicate an installation problem.

Keeping the Project Updated

To download the latest changes:

git pull origin main

If you're contributing to the project, regularly synchronize your fork with the upstream repository.

Next Steps

Congratulations! Adventure-Game is now installed and ready to use.

Continue with the following documentation:

  • Project Structure – Learn how the repository is organized.
  • Architecture – Understand the internal design of the project.
  • Character System – Explore player attributes and progression.
  • Inventory System – Learn how items are stored and managed.
  • Development Guide – Start contributing to the project.

Additional Resources

For more information, visit:

  • README.md – General project overview.
  • CONTRIBUTING.md – Contribution guidelines.
  • SECURITY.md – Security policy.
  • GitHub Issues – Report bugs or request new features.

If you encounter any installation problems that are not covered here, feel free to open an Issue in the repository. Contributions that improve installation instructions are always welcome.

Clone this wiki locally