🪓 Timberman

A fast-paced tree-chopping arcade game built with C++17 and SFML 2.5.
Chop as many logs as you can before the timer runs out — but watch out for branches!

---

🎮 Gameplay

Key	Action
Enter	Start / Restart game
← Left Arrow	Chop left side
→ Right Arrow	Chop right side
Escape	Quit

• Each chop adds to your score and grants a small time bonus.
• A branch on your side when you chop kills you instantly.
• The time bar depletes continuously — keep chopping!

---

🗂️ Project Structure

timberman/
├── src/
│   ├── main.cpp        # Entry point
│   └── Game.cpp        # Core game logic
├── include/
│   └── Game.hpp        # Game class declaration
├── graphics/           # PNG assets (included)
├── fonts/              # TTF fonts (included)
├── sound/              # WAV sound effects (included)
├── CMakeLists.txt      # CMake build script
└── README.md

---

🔧 Prerequisites

Dependency	Version
C++ compiler (GCC / Clang / MSVC)	C++17 or later
SFML	2.5.x
CMake	3.16+

---

🚀 Build & Run

🐧 Linux (Ubuntu / Debian)

1. Install dependencies

sudo apt install libsfml-dev cmake build-essential

2. Clone and build

git clone https://github.com/AKumarOfficial/timberman.git
cd timberman
cmake -S . -B build
cmake --build build

3. Run

./build/Timberman

---

🪟 Windows (MinGW)

1. Install prerequisites

• CMake → cmake.org/download (check "Add to PATH" during install)
• MinGW-w64 (GCC) → winlibs.com (download the GCC 64-bit release)
• SFML 2.5.1 → sfml-dev.org/download.php (pick the "GCC MinGW 64-bit" build)
  Extract it somewhere easy, e.g. C:\SFML-2.5.1

2. Clone the repository

git clone https://github.com/AKumarOfficial/timberman.git
cd timberman

3. Configure and build

cmake -S . -B build -G "MinGW Makefiles" -DSFML_DIR="C:/SFML-2.5.1/lib/cmake/SFML"
cmake --build build

Replace C:/SFML-2.5.1 with your actual SFML extraction path.

4. Copy SFML DLLs (required on Windows so the .exe can find them)

copy "C:\SFML-2.5.1\bin\*.dll" build\

5. Run

build\Timberman.exe

---

🪟 Windows (Visual Studio)

1. Install prerequisites

• Visual Studio 2019 or later with the "Desktop development with C++" workload
• CMake → cmake.org/download
• SFML 2.5.1 → sfml-dev.org/download.php (pick the "Visual C++ 15 (2017) 64-bit" build)
  Extract to e.g. C:\SFML-2.5.1

2. Clone the repository

git clone https://github.com/AKumarOfficial/timberman.git
cd timberman

3. Configure and build

cmake -S . -B build -DSFML_DIR="C:/SFML-2.5.1/lib/cmake/SFML"
cmake --build build --config Release

4. Copy SFML DLLs

copy "C:\SFML-2.5.1\bin\*.dll" build\Release\

5. Run

build\Release\Timberman.exe

---

🍎 macOS (Homebrew)

1. Install dependencies

brew install sfml cmake

2. Clone and build

git clone https://github.com/AKumarOfficial/timberman.git
cd timberman
cmake -S . -B build
cmake --build build

3. Run

./build/Timberman

---

🛠️ Common Errors

Error	Fix
SFML not found	Set -DSFML_DIR to the correct path
Failed to load texture: graphics/...	Make sure asset folders are inside the project root
.dll not found on Windows	Copy all DLLs from SFML/bin/ next to the .exe
mingw32-make not found	Add MinGW bin/ folder to your system PATH

---

📁 Assets

All assets are included in the repository — no additional downloads needed.

graphics/
├── background.png
├── tree.png
├── branch.png
├── player.png
├── axe.png
├── log.png
├── rip.png
├── bee.png
├── cloud.png
└── bird.png

fonts/
└── KOMIKAP_.ttf

sound/
├── chop.wav
├── death.wav
└── out_of_time.wav

---

🏗️ Architecture

The project is structured around a single Game class following the classic game loop pattern:

Game::run()
 ├── processEvents()   — keyboard / window events
 ├── update(dt)        — physics, AI, collision, timer
 └── render()          — clear → draw → display

All state is encapsulated in Game; main.cpp is purely an entry point with error handling.

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/awesome-thing)
3. Commit your changes (git commit -m "Add awesome thing")
4. Push to the branch (git push origin feature/awesome-thing)
5. Open a Pull Request

---

📄 License

This project is licensed under the MIT License — see LICENSE for details.