septag / Rizz

Rizz

@septag

Rizz (ریز) is a tiny, multi-platform, and minimal game/app development framework, Written in C language. Inspired by The Machinery and sokol libs. It's currently a work in progress, features and improvements will be added constantly to different platforms.

Design and Basic usage

For more detailed information about design principles, architecture and basic usage of the framework, please read the document rizz Architecture and Basic usage, which is also available in docs/guide

Note

This is not a game engine, it's a relatively low-level framework for programmers to build their own engine/renderer/physics on top of it. The core of rizz does not and will not implement any rendering techniques/physics or impose any specific entity system to the user. It just provides the basic building blocks for game developers. Other features will be implemented as plugins.

Features

Core

• Portable C code: C11 (gcc/clang), C99 (msvc) compatible code, designed with data-oriented mindset.
• Plugin system: Engine has a small core. Many functionalities are implemented through plugins.
• Minimal Dependencies: No external/large dependencies. Only a handful of small dependencies included in the source.
• Hot-reloading of C/C++ code: Plugins/Game code are all hot-reloadable with some restrictions and rules.
• Fiber based job system: Simple to use fiber-based job system.
• Reflection: Provides simple reflection system for structs, enums and functions along with built-in JSON serialization/deserialization.
• Async Asset Manager: Flexible reference counting asset manager. New asset types can be added by third-party code to the manager.
• Hot-reloading of assets and shaders: All in-game resources and shaders can be hot-reloaded.
• Virtual file system: Async read/write. Directories or archives can be mounted as virtual directories.
• Support for coroutines: Coroutines can be suspended for N frames or N milliseconds.
• Custom crash handling: Custom callbacks for crashes. Along with Crash.dmp file creation (windows only)

Graphics

• Multiple graphics API support: Metal (iOS, MacOS). OpenGL-ES 2/3 (Android). Direct3D11 (Windows), OpenGL 3.3 (Linux)
• Portable shaders: Write shaders once in GLSL, toolset will automatically translate the shader to other APIs.
• Multi-threaded GPU command-buffer: Draw commands can be submitted by multiple threads with staged API.
• Compute shader support (Experimental): Experimental compute-shader support, currently only under Direct3D, more backends will be added.
• basis_universal texture format support

Plugins

Many of the engine features are implemented in the plugins, visit each link to read their README:

• imgui: Dear-imgui plugin with some utility API
• 2dtools: 2D rendering tools: sprite, sprite animation, font drawing with TTF support
• sound: Simple sound system. Audio mixer and 2d-sounds.
• input: Input system with gamepad and touch support
• 3dtools: 3D rendering tools: support for GLTF 3d models, basic debug primitive creation and drawing
• astar: A-star path-finding implementation plugin
• collision: 2.5D/Isometric Collision detection plugin
• utility: misc utility functionality. Currently, spline and noise generator

Debugging and Profiling

• Remote Profiler: Integrated Remotery for remote debugger/command console and log viewer.
• Graphics API introspection: Debug application level graphic calls and objects.
• Memory Debugger: Debug and monitor memory allocations for all subsystems.

Supported platforms

• Windows
• Linux
• MacOS
• Android
• RaspberryPI
• iOS

Build

rizz is designed to run on all major mobile (iOS, android), PC (Windows, Linux, MacOS) and web (WebASM) platforms. But as the engine is in it's early age, the current platforms are built and tested:

• Windows: Tested on Windows10 with visual studio 14 2015 update 3 (Win64).
• Linux: Tested on ubuntu 16 with clang (6.0.0) and gcc (7.3.0). Package requirements:
  • libx11-dev
  • libxrandr-dev
  • libxi-dev
  • libasound2-dev (if you are planning to build sound plugin)
  • libglew-dev
• MacOS: Tested on MacOS High Sierra - AppleClang 9.1.0
• Android: For android, there is a python script android.py which takes care of preparing android project structure, building the code and packaging the final APK. please read the begining of android.py.
• RaspberryPI: Tested on RPi1 ModelB Ubuntu-jessie (gcc Raspbian 4.9.2). Package requirements:
  • libasound2-dev (if you are planning to build sound plugin)
• iOS: For iOS, there is a python script ios.py which takes care of initializing iOS project

CMake options

• BUNDLE (default=0, android/ios=1):

  • BUNDLE=0 indicates that rizz is built as an executable host which runs the game by rizz --run game.dll (on linux it's rizz --run ./game.so). Recommended for development, where you need reduced binary sizes and live-reloading of game code and plugins.
  • BUNDLE=1 Builds rizz as static library. To link and bundle rizz and other plugins with a single stand-alone executable, so there will be only one executable and bundles rizz and all the plugins you specify. to build the bundle properly, you should set these cmake arguments on configure:
    • BUNDLE_TARGET: target name of the executable you are trying to build (first example: -DBUNDLE_TARGET=01-hello)
    • BUNDLE_TARGET_NAME: if the cmake target and the actual name of your application differs, use argument to address that. (first example: -DBUNDLE_TARGET_NAME=hello)
    • BUNDLE_PLUGINS: list the plugins that is required by your application, separated by semicolon. (first example: -DBUNDLE_PLUGINS=imgui)

• ENABLE_HOT_LOADING (default=1, android/ios=0) Enables hot reloading of assets and monitoring the assets directories. Doesn't work on mobile OSes.

• ENABLE_PROFILER (default=0/debug, default=1/release)

• BUILD_EXAMPLES (default=1, android/ios=0) Build example projects in /examples directory.

• MSVC_STATIC_RUNTIME (default=0): MSVC specific. Compiles the RELEASE config with '/MT' flag instead of '/MD'

• MSVC_MULTITHREADED_COMPILE (default=1): MSVC specific. Turns on multi-threaded compilation (turns it off with Ninja)

• CLANG_ENABLE_PROFILER (default=0): Clang specific. Turns on -ftime-trace flag. Only supported in clang-9 and higher

Examples

Examples Basic examples are included with this repo, in examples directory:

Space invaders clone - link to github project

Changes

v0.5

WIP

v0.4

• BREAKING: json parser, replace sjson with cj5
• BREAKING: renamed sprite plugin to 2dtools
• BREAKING: external macro APIS (rizz_log_xxxx) are now same as internal ones (api variable is defined in header)
• BREAKING: Reflection now has contexts in it's API
• NEW: imgui log window
• NEW: true-type font (fontstash) support through 'rizz_api_font' API
• NEW: basis texture support
• NEW: astar path-finding plugin, thanks to @aminv
• NEW: Hybrid collision detection plugin
• NEW: "json" asset type (see rizz/json.h)
• NEW: utility plugin (spline, noise, more stuff will be added), thanks to @aminv
• Updated remotery
• ImGui to 1.79-docking branch
• sx io API and backend to native instead of std.fopen
• Async vfs API tget individual files
• IFF load/save API in sx/io.h
• shader_get/texture_get and other asset getters to all asset types
• Lots of math lib improvements and refactors
• tmp_alloc overhaul
• fixes in dds-ktx parser
• MSVC compiler C11 support
• Better C-API compatbility with C++, and some simple wrappers for C++ (array, hash-table, math operators, ..)
• Reflection system improvements, two new serialize/deserialize functions for writing custom serialization
• Reflection system built-in JSON serialization
• New ImGui theme (Thanks to @aminv)

Open-Source libraries used

Primarily developed for rizz

• sx: Portable base library
• glslcc: GLSL cross-compiler (external binary tool)
• dds-ktx: Single header KTX/DDS reader
• cj5: Very minimal single header JSON5 parser in C99, derived from jsmn
• atlasc: Command-line tool that builds atlas texture from a bunch of input images. (External binary tool)
• dmon: Single header C99 portable library for monitoring directory changes.

3rdparties

• sokol: minimal cross-platform standalone C headers
• cr: Simple C Hot Reload Header-only Library
• cimgui: C-API for imgui (used in imgui plugin)
• imgui: Dear ImGui: Bloat-free Immediate Mode Graphical User interface for C++ with minimal dependencies (used in imgui plugin)
• Remotery: Single C file, Realtime CPU/GPU Profiler with Remote Web Viewer
• lz4: Extremely Fast Compression algorithm
• http: Basic HTTP protocol implementation over sockets
• stb: stb single-file public domain libraries for C/C++
• sort: Sorting routine implementations in "template" C
• ImGuizmo: 3D gizmo for imgui (used in imgui plugin)
• gainput: Input library for games (used in input plugin)
• basis_universal: Basis Universal GPU Texture Codec
• fontstash: Light-weight online font texture atlas builder (used in 2dtools plugin)
• cgltf: Single-file glTF 2.0 loader and writer written in C99 (used in 3dtools plugin)
• cute_headers: Randy Gaul's header libs (cute_c2.h used in collision plugin)

License (BSD 2-clause)

Copyright 2019 Sepehr Taghdisian. All rights reserved.

https://github.com/septag/rizz

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

   1. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.

   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.