# chicane

**Repository Path**: alonebinge/chicane

## Basic Information

- **Project Name**: chicane
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-02
- **Last Updated**: 2025-08-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <img src="https://raw.githubusercontent.com/pepeien/chicane/master/.github/images/logo.svg" alt="Chicane logo" />
</p>

<p align="center">
    <span>Chicane is a lightweight, cross-platform C++17 graphics engine with a focus on modularity and flexibility</span>
</p>

## Features
- Multiplataform:
    - Windows (^=10);
    - Linux.
- Asset system: 
    - Audio:
        - Waves Audio (.wav).
    - Fonts:
        - TrueType Font (.ttf).
    - 3D Models:
        - Wavefront (.obj).
    - Textures:
        - PNG (.png).
- UI system:
    - Button;
    - Container;
    - Popup;
    - Text;
    - Input;
    - View.
- Graphics API support:
    - Vulkan:
        - Shadow mapping.

## Compiling
This project uses CMake to generate and build files, it should pretty straight forward both on linux and windows platforms.

### Compilers
- Windows:
    - MinGW (^=11.2);
    - Visual Studio (^=19).
- Linux:
    - Clang (^=17);
    - GCC (^=14.20).

### Requeriments
- Build:
    - [CMake](https://cmake.org/download) (^=3.16.0).
- Script:
    - [Python](https://www.python.org/downloads) (^=3.12.0).
- Renderer:
    - [Vulkan](https://www.lunarg.com/vulkan-sdk) (^=1.4.313.2).

## Examples
If you desire to check some examplary code, this repository hosts a sample located at `Sources/Sample`.

## Documentation
Further documentation is hosted at [Chicane Engine Documentation](https://chicane.erickfrederick.com), available in English (en-us), Japanese (ja-jp) and Brazillian Portuguese (pt-br).