https://github.com/jack-ji/zplay

A simple framework intended for game/tool creation.
https://github.com/jack-ji/zplay

Last synced: 3 months ago
JSON representation

A simple framework intended for game/tool creation.

• Host: GitHub
• URL: https://github.com/jack-ji/zplay
• Owner: Jack-Ji
• License: mit
• Archived: true
• Created: 2022-05-11T12:02:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T07:29:47.000Z (about 2 years ago)
• Last Synced: 2024-08-03T04:08:00.678Z (7 months ago)
• Language: C
• Size: 3.79 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zig - zplay🗒️A simple framework intended for game/tool creation

README

        
# zplay

A simple framework intended for game/tool creation.

## Features

* Little external dependency, only SDL2 and OpenGL3/GLES3

* Support PC platforms: windows/linux (possibly macOS, don't know for sure)

* Flexible render-passes pipeline, greatly simplify rendering code

* Graphics oriented math library: Vec2/Vec3/Mat4/Quaternion ([zalgebra](https://github.com/kooparse/zalgebra))

* Vector graphics drawing ([nanovg](https://github.com/memononen/nanovg))

* Immediate mode GUI toolkits ([dear-imgui](https://github.com/ocornut/imgui))

* Realtime data visualization ([ImPlot](https://github.com/epezent/implot))

* TrueType font loading and rendering

* Image picture loading/decoding/writing (support png/jpg/bmp/tga)

* Audio playback (support wav/flac/mp3/vorbis)

* 2D toolkits:

  * Camera component

  * Sprite and SpriteBatch system

  * Texture packer used to programmatically create sprite-sheet

  * Particle system

  * Chipmunk physics lib integration

* 3D toolkits:

  * Camera component

  * Model loading and rendering (only glTF 2.0 for now)

  * Blinn-Phong renderer (directional/point/spot light)

  * Environment mapping renderer

  * Skybox renderer

  * Bullet3 physics lib integration (credit to [zig-gamedev](https://github.com/michal-z/zig-gamedev))

## Getting started

Copy `zplay` folder or clone repo (recursively) into `libs` subdirectory of the root of your project.

Install SDL2 library, please refer to [docs of SDL2.zig](https://github.com/MasterQ32/SDL.zig)

Then in your `build.zig` add:

```zig

const std = @import("std");

const zplay = @import("libs/zplay/build.zig");

pub fn build(b: *std.build.Builder) void {

    const exe = b.addExecutable("your_bin", "src/main.zig");

    exe.setBuildMode(b.standardReleaseOptions());

    exe.setTarget(b.standardTargetOptions(.{}));

    exe.install();

    zplay.link(exe, .{

      // choose graphics api (gl33/gles3)

      // link optional modules (imgui/nanovg etc)

    });

    const run_cmd = exe.run();

    run_cmd.step.dependOn(b.getInstallStep());

    const run_step = b.step("run", "Run the app");

    run_step.dependOn(&run_cmd.step);

}

```

Now in your code you may import and use zplay:

```zig

const std = @import("std");

const zp = @import("zplay");

fn init(ctx: *zp.Context) anyerror!void {

    _ = ctx;

    std.log.info("game init", .{});

    // your init code

}

fn loop(ctx: *zp.Context) anyerror!void {

    while (ctx.pollEvent()) |e| {

        switch (e) {

            .quit_event => ctx.kill(),

            else => {},

        }

    }

    // your game loop

}

fn quit(ctx: *zp.Context) void {

    _ = ctx;

    std.log.info("game quit", .{});

    // your deinit code

}

pub fn main() anyerror!void {

    try zp.run(.{

        .initFn = init,

        .loopFn = loop,

        .quitFn = quit,

    });

}

```

## Third-Party Libraries

* [SDL2](https://www.libsdl.org) (zlib license)

* [glad-generated OpenGL3 loader](https://glad.dav1d.de) (Apache Version 2.0 license)

* [zalgebra](https://github.com/kooparse/zalgebra) (MIT license)

* [miniaudio](https://miniaud.io/index.html) (MIT license)

* [cgltf](https://github.com/jkuhlmann/cgltf) (MIT license)

* [stb headers](https://github.com/nothings/stb) (MIT license)

* [dear-imgui](https://github.com/ocornut/imgui) (MIT license)

* [ImPlot](https://github.com/epezent/implot) (MIT license)

* [imnodes](https://github.com/Nelarius/imnodes) (MIT license)

* [nanovg](https://github.com/memononen/nanovg) (zlib license)

* [nanosvg](https://github.com/memononen/nanosvg) (zlib license)

* [bullet3](https://github.com/bulletphysics/bullet3) (zlib license)

* [chipmunk](https://chipmunk-physics.net/) (MIT license)

* [nativefiledialog](https://github.com/mlabbe/nativefiledialog) (zlib license)

* [known-folders](https://github.com/ziglibs/known-folders) (MIT license)