Corn Game Engine (Under Development)

Corn is a lightweight, cross-platform PC-based game engine that supports Windows, Mac, and Linux (tested on Ubuntu). It's designed to be easy to use and efficient, allowing developers to create high-quality games with ease.

Features

• Compatible with Windows, macOS, and Linux
• 2D rendering (3D in future plans)

Prerequisites

• MSVC (Windows) / MinGW-w64 13.1.0 (Windows) / Clang (macOS) / GCC (Linux)
• (Optional) CMake: Only if building from the source. Make sure it is in PATH.
• (Optional) vcpkg: Only if building from the source. Make sure it is in PATH.
• (Optional) Simple and Fast Multimedia Library (SFML) 2.6: Only if building from the source (installed in vcpkg).
• (Optional) International Components for Unicode (ICU): Only if building from the source (installed in vcpkg).
• (Optional) Earcut: Only if building from the source (installed in vcpkg).
• (Optional) GoogleTest: Only if building the test cases (installed in vcpkg).

Getting Started

To begin, clone the repository to your local machine using:

git clone https://github.com/cty012/corn.git
cd corn

Prerequisites

Ensure you have CMake and vcpkg installed and added to your PATH. Replace <path_to_vcpkg> with the full path where vcpkg is installed on your system.

Build Instructions

1. Common step for all platforms:

   Start by running the following command, replacing <triplet> with the appropriate target triplet for your platform (explained below):

   cmake -B build -DCMAKE_TOOLCHAIN_FILE=<path_to_vcpkg>/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=<triplet>
   cmake --build build --config Release

2. Platform-specific instructions:

   • MSVC (Windows):

     Use the triplet x64-windows-static-md.

   • MinGW-w64 (Windows):

     Warning: ICU might not compile using MinGW. MSVC is recommended on Windows systems.

     Use the triplet x64-mingw-static.

   • Clang (macOS):

     First, install the following dependencies before running cmake:

     brew install autoconf autoconf-archive automake libtool pkg-config

     Then, determine your Mac's CPU architecture. You can use uname -m in the terminal. It will return arm64 for Apple Silicon (like M1/M2 chips) or x86_64 for Intel-based Macs. If your CPU architecture is Apple Silicon then use arm64-osx-release as the triplet. If it is Intel then use x64-osx-release.

   • GCC (Linux): Use the triplet x64-linux-release.

After building, the compiled dynamic library will be available in the build directory.

Installation

Install the library by running the following command in the project root:

cmake --install build

This will install the library into the dist folder. For both debug and release builds, repeat the command with the respective build folders.

Documentation

The documentation of this project is generated using Doxygen. To generate the documentation, install Doxygen and run the following command:

cd docs && doxygen

Acknowledgments

• CMake - Licensed under BSD 3-Clause License
• vcpkg - Licensed under MIT License
• SFML - Licensed under zlib/libpng License
• ICU - Licensed under ICU License
• NanoSVG - Licensed under zlib/libpng License
• Boost Geometry - Licensed under Boost Software License 1.0
• Earcut - Licensed under ISC License
• GoogleTest - Licensed under BSD 3-Clause License