https://github.com/ilbuso/zombie

A 2D game-engine in c++ using SDL
https://github.com/ilbuso/zombie

cpp gameengine makefile sdl2 sdl2-image

Last synced: 10 months ago
JSON representation

A 2D game-engine in c++ using SDL

• Host: GitHub
• URL: https://github.com/ilbuso/zombie
• Owner: ilBuso
• License: mit
• Created: 2024-02-08T15:27:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-01T14:22:27.000Z (almost 2 years ago)
• Last Synced: 2025-03-30T17:29:38.579Z (about 1 year ago)
• Topics: cpp, gameengine, makefile, sdl2, sdl2-image
• Language: C++
• Homepage:
• Size: 447 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Zombie

#### by *ilBuso*

![Linux Badge](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=000&style=for-the-badge)

![C++ Badge](https://img.shields.io/badge/C%2B%2B-00599C?logo=cplusplus&logoColor=fff&style=for-the-badge)



# TOC

- [Overview](#overview)

  - [Development Details](#development-details)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [License](#license)

# Overview

**Zombie** is a game engine I developed as a side project to enable future game development in C++. Up until now, I have been the sole contributor to the project. As my first venture into game engine development, it is not perfect, but it represents a significant learning experience and a foundation for further development and improvement.

## Development Details

This game engine has been developed exclusively on Linux and is not intended to be compatible with other operating systems. The project is written in `C++` and utilizes the `SDL2` library to manage graphics, input, and other multimedia functions. For building the project, a Makefile is used to streamline the compilation process. Additionally, the codebase is consistently formatted using `clang-format`, ensuring that the code adheres to a uniform style throughout the project.

# Getting Started

## Prerequisites

To build and run this game engine, you will need to have the following installed on your system:

- `g++`

- `make`

## Installation

1. Clone the repository:

   ```sh

   git clone https://github.com/ilBuso/zombie.git

   ```

2. Change into the project directory:

   ```sh

   cd zombie

   ```

3. Build the project using `make`:

   ```sh

   make

   ```

# Usage

For detailed information on how to get started with using and developing this game engine, please refer to the documentation. All necessary information can be found in the `doc` folder of the repository. The main documentation file is [DOCUMENTATION.md](./doc/DOCUMENTATION.md).

# Contributing

At this moment, I am not accepting contribution to the game engine. However, I appreciate your interest and contributions may be considered in the future.

# License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.