Developed by: Maham Anjum & Romaisa
Language: C++
Graphics/Audio Library: SFML (Simple and Fast Multimedia Library)
Build System: CMake

1. What is Xonix?
2. Project Structure
3. Dependencies
4. How to Build and Run
5. How to Run on Turbo C++ (TC)
6. Menu Navigation Guide
7. Game Controls
8. Levels & Difficulty
9. Player Modes
10. Gameplay Rules & Mechanics
11. Scoring System
12. Power-Up System
13. Enemy Behavior
14. Win & Lose Conditions
15. File Descriptions
16. Common Errors & Fixes

Xonix is a classic territory-capture arcade game. You control a player that moves across a grid. Your goal is to fill/capture tiles by drawing paths and enclosing areas — without getting hit by enemies. The more area you capture, the higher your score.

xonix/
├── main.cpp                    ← Full game source code
├── CMakeLists.txt              ← Build configuration file
├── images/
│   ├── bg.png                  ← Background image
│   ├── tiles.png               ← Tile sprites
│   ├── enemy.png               ← Enemy sprite
│   └── gameover.png            ← Game over screen image
├── lt_internet/
│   ├── LTInternet-Bold.ttf     ← Font (Bold)
│   └── LTInternet-Regular.ttf  ← Font (Regular)
└── build/
    ├── xonix                   ← Compiled executable (Linux)
    ├── ARIAL.TTF               ← Font used in-game
    ├── bgmusic.ogg             ← Background music
    ├── menu.txt                ← Main menu display text
    ├── levels.txt              ← Levels menu display text
    ├── endmenu.txt             ← End/game-over menu text
    ├── playermodes.txt         ← Player mode selection text
    ├── scoreboard.txt          ← Saved high scores (auto-updated)
    ├── highscore.txt           ← Highest score record
    └── images/                 ← Copy of images used at runtime

Before building, you must install the following:

SFML handles the game window, graphics, and audio.

On Ubuntu/Debian Linux:

sudo apt-get update
sudo apt-get install libsfml-dev

On Fedora/RHEL:

sudo dnf install SFML-devel

On Windows: Download from https://www.sfml-dev.org/download.php and link manually.

On macOS:

brew install sfml

sudo apt-get install cmake

sudo apt-get install g++

unzip xonix.zip
cd xonix

mkdir build
cd build

cmake ..

make

This produces an executable called xonix inside the build/ folder.

./xonix

Important: You MUST run the game from inside the build/ directory because it reads files like ARIAL.TTF, menu.txt, bgmusic.ogg, and images/ from the current working directory.

If you try to run it from a different location, you will get errors like:

• Error loading background music!
• failed to load background image!

Correct way:

cd /path/to/xonix/build
./xonix

⚠️ Important Notice: This project cannot run natively in Turbo C++ because:

• It uses SFML, which is a modern C++ library not supported by Turbo C++.
• Turbo C++ is a 16-bit compiler (circa 1990s) and does not support modern C++11/14/17 features used in this code (like stringstream, max(), min(), modern STL, etc.).
• It uses #include<SFML/Graphics.hpp> and #include<SFML/Audio.hpp> which are unavailable in TC.

Option A — Use a modern IDE on Windows:

1. Install Visual Studio Community (free) from https://visualstudio.microsoft.com/
2. Install SFML for Windows from https://www.sfml-dev.org/
3. Create a new C++ project, add main.cpp, link SFML libraries.
4. Copy build/ contents (images, fonts, txt files, ogg file) next to your executable.
5. Build and run.

Option B — Use Code::Blocks with MinGW (Windows):

1. Download Code::Blocks with MinGW: http://www.codeblocks.org/
2. Download SFML (MinGW version) from https://www.sfml-dev.org/
3. In Code::Blocks:
   • Go to Project → Build Options → Linker Settings
   • Add: sfml-graphics, sfml-window, sfml-system, sfml-audio, sfml-network
   • Add the SFML include and lib paths in Search Directories.
4. Add main.cpp and compile.
5. Copy runtime files (ARIAL.TTF, images/, bgmusic.ogg, etc.) to the output folder.

Option C — Use WSL (Windows Subsystem for Linux):

1. Enable WSL on Windows: open PowerShell as Admin and run:

   wsl --install
   

2. Open Ubuntu terminal via WSL.
3. Install SFML: sudo apt-get install libsfml-dev
4. Follow the Linux build steps above.

Option D — Already have a pre-built binary (Linux):

The build/xonix file inside the zip is a pre-compiled Linux executable. If you are on Linux, you can run it directly:

cd xonix/build
chmod +x xonix
./xonix

All menus are controlled using keyboard number keys and Escape.

Welcome to Xonix Game!
1. Start Game
2. Scoreboard
3. Exit

Select Difficulty Level:
1. Easy         (2 enemies)
2. Medium       (4 enemies)
3. Hard         (6 enemies)
4. Continuous Mode

SELECT PLAYER MODE
1. Single Player
2. Two Players

Displays the top scores from past sessions (read from scoreboard.txt).

Shown after you win or lose:

Options:
1 - Restart
2 - Scoreboard
3 - Main Menu
4 - Exit

Two-player controls are present in the code. Player 2 uses a separate key set (see twoPlayerMode flag in code — implementation depends on current build).

Speed Increase: Every 20 seconds in any level, all enemies increase their speed by +0.2x.

Pattern Change: After 30 seconds of gameplay, half the enemies switch from linear movement to zigzag or circular movement.

• Single Player: You control one player using arrow keys.
• Two Player: Both players share the grid. Controlled via keyboard (check twoPlayerMode logic in main.cpp).

• The game board is a 25 × 40 tile grid.
• Each tile is 18 pixels wide.
• The border (outermost ring) is pre-filled and acts as a wall.

1. Move off the border into the open area — your trail is drawn in orange-red.
2. Return to the border (blue wall) to close the path.
3. The system uses a flood-fill algorithm from each enemy's position.
4. Areas the flood-fill does not reach are considered enclosed and get filled (gold).
5. You earn 1 point per tile you enter, plus bonuses.

You die (game over) if:

• An enemy touches your current trail (orange-red tiles).
• An enemy reaches your player position.
• An enemy enters a filled area (gold tiles).

High Score: Saved automatically to scoreboard.txt at game over or victory. Top 5 scores are shown in the Scoreboard screen.

Earning Power-Ups:

• You receive 1 power-up when you reach score 50.
• After that, you get 1 power-up every 30 additional points (80, 110, 140, ...).

Using Power-Ups:

• Press Space during gameplay.
• All enemies are frozen for 3 seconds.
• Power-up count is shown on the HUD (top-left of screen).

Enemies start with linear movement (bouncing diagonally). After 30 seconds:

When an enemy hits a wall tile, it reverses direction. Enemy speed cannot be zero — if it reaches zero it is randomly assigned a new direction.

• Every interior tile of the grid is captured (filled gold or wall blue).
• Screen shows: VICTORY! You captured all tiles!
• Final score, time played, and total moves are shown.

• An enemy hits your trail or player position.
• Screen shows: GAME OVER with your final score.

After either outcome, music stops and the End Menu appears.

Open main.cpp and find line ~247:

if(!backgroundMusic.openFromFile("/home/maham/Downloads/xonix/build/bgmusic.ogg")) {

Change it to:

if(!backgroundMusic.openFromFile("bgmusic.ogg")) {

Then recompile using make.

# 1. Extract
unzip xonix.zip && cd xonix

# 2. Install SFML (Linux)
sudo apt-get install libsfml-dev cmake g++

# 3. Fix the hardcoded music path in main.cpp (line ~247)
# Change: /home/maham/Downloads/xonix/build/bgmusic.ogg
# To:     bgmusic.ogg

# 4. Build
mkdir build && cd build
cmake ..
make

# 5. Run (must be inside build/ folder)
./xonix

README generated from source code analysis of main.cpp, CMakeLists.txt, and all runtime text files.