F·W·K

3D game framework in C, with Luajit bindings now.

Goals

Features ᕦ(ᐛ)ᕤ

Roadmap ᕕ(ᐛ)ᕗ (in order of arrival; ✱: partial support)

Gallery

Hello FWK

#include "fwk.h" // Minimal C sample
int main() {
    window_create(75.0, 0); // 75% size, no extra flags
    while( window_swap() && !input(KEY_ESC) ) { // game loop
        puts("hello FWK from C!");
    }
}

local fwk = require("fwk") -- Minimal Lua sample
fwk.window_create(75.0,0) -- 75% size, no extra flags
while fwk.window_swap() and fwk.input(fwk.KEY_ESC) == 0 do -- game loop
    print("hello FWK from Lua!")
end

#include "fwk.h" // Minimal HTML5 sample
void render(void *arg) {
    if( !input(KEY_ESC) ) { 
        puts("hello FWK from HTML5!");
    }
}
int main() {
    window_create(75.0, 0); // 75% size, no extra flags
    window_loop(render, NULL); // game loop
}

Build (as static library)

Type MAKE.bat (Win) or sh MAKE.bat (Linux/OSX) to build everything. Alternatively,

echo Windows (vc+tcc)      && cl  demo.c       fwk.c
echo Windows (mingw64)     && gcc demo.c       fwk.c -o demo -w -lws2_32 -lgdi32 -lwinmm -ldbghelp
echo Linux (gcc+clang+tcc) && cc  demo.c       fwk.c -o demo -w -lm -ldl -lpthread -lX11
echo OSX (gcc+clang)       && cc  demo.c -ObjC fwk.c -o demo -w -framework cocoa -framework iokit

Note: TCC is partially supported on Windows+Linux. Beware, no threading.

Build (as dynamic library)

Type MAKE.bat dll or sh MAKE.bat dll (Linux/OSX) to build FWK as a dynamic library. Alternatively,

echo Windows && cl fwk.c /LD /DAPI=EXPORT
echo Linux   && cc -fPIC fwk.c -shared -o libfwk.so -w -lX11
echo OSX     && cc -ObjC -dynamiclib -o libfwk.dylib fwk.c -framework cocoa -framework iokit -w

Quick test on Windows: cl demo.c fwk.lib /DAPI=IMPORT
Or also, copy the dynamic library into demos/lua and then run luajit demo_luajit_model.lua from there.

Amalgamation

Split FWK into separate files by running MAKE.bat split (or sh MAKE.bat split in Linux/OSX).
Merge those files back into FWK by running MAKE.bat join (or sh MAKE.bat join in Linux/OSX).
Optionally, generate a single-header distribution by executing following script:

echo // This C file is a header that you can #include. Do #define FWK_C  > fwk-single-header.c
echo // early in **one** compilation unit to unroll the implementation. >> fwk-single-header.c
type fwk.h           >> fwk-single-header.c
echo #ifdef FWK_C    >> fwk-single-header.c
echo #pragma once    >> fwk-single-header.c
type fwk.c           >> fwk-single-header.c
echo #endif // FWK_C >> fwk-single-header.c

Extra tips

Dropped files into game window will be imported & saved into editor/import folder.
Linux/OSX users can optionally install wine to use the Windows pipeline as an alternate asset pipeline (use --with-wine flag).
Although not recommended, you can remove the cooking stage by invoking --with-cook-jobs=0 or by removing the editor/tools folder.
Depending on your IDE, you might need to split all amalgamated files when debugging FWK.

Bindings

Luajit: Luajit bindings are provided in the fwk.lua auto-generated file.
Nelua: Nelua bindings provided by Rabia Alhaffar.

License

This software is released into the public domain.
Also dual-licensed as 0-BSD or MIT (No Attribution) for those countries where public domain is a concern (sigh).
Any contribution to this repository is implicitly subjected to the same release conditions aforementioned.

Credits (Artwork + demos)

DavidLam, for tokamak physics engine (ZLIB).
FMS_Cat, for nicest VHS/VCR shader around (MIT).
Goblin165cm, for witch 3D model (CC BY 4.0).
Nanofactory, for kgirls01 3D model (CC BY-NC-ND 4.0).
Quaternius, for the lovely 3D robots (CC0).
Rxi, for lovely sprites & cats demo (MIT).
wwwtyro, for nicest rayleigh/mie scattering shader around (CC0).

Credits (Tools)

Aaron Barany, for cuttlefish (APACHE2).
Assimp authors, for assimp (BSD3).
Bernhard Schelling, for tml.h (Zlib) and tsf.h (MIT).
ffmpeg authors, for ffmpeg (LGPL21).
Imagination, for pvrtextoolcli (ITL).
Krzysztof Gabis, for split.py/join.py (MIT).
Lee Salzman, for iqm.cpp (PD).
Martín Lucas Golini, for emscripten-fs.html (CC0).
Mattias Gustavsson, for mid.h (PD).
Michael Schmoock, for lcpp (MIT).
Morgan McGuire, for markdeep (BSD2).
Tomas Pettersson, for sfxr (PD).
Tor Andersson, for assiqe.c (BSD).

Credits (Runtime)

Barerose, for swrap (CC0).
Camilla Löwy, for glfw3 (Zlib).
Dave Rand for ppp (PD).
David Herberth, for glad generated code (PD).
David Reid, for miniaudio (PD).
Dominic Szablewski, for pl_mpeg (MIT).
Dominik Madarász, for json5 parser (PD).
Eduard Suica, for tlse (PD).
Gargaj+cce/Peisik, for Foxotron/PBR shaders (UNLICENSE).
Guillaume Vareille, for tinyfiledialogs (ZLIB).
Haruhiko Okumura for lzss (PD).
Igor Pavlov for LZMA (PD).
Ilya Muravyov for bcm, balz, crush, ulz, lz4x (PD).
Jon Olick, for jo_mp1 and jo_mpeg (PD).
Joonas Pihlajamaa, for JUnzip library (PD).
Lee Salzman, for IQM spec & player (PD).
Lee Salzman, V.Hrytsenko and D.Madarász, for enet (MIT).
Libtomcrypt, for libtomcrypt (Unlicense).
Lua authors, for Lua language (MIT).
Mattias Gustavsson, for thread.h and https.h (PD).
Micha Mettke, Chris Willcocks, Dmitry Hrabrov, for nuklear (PD).
Omar Cornut, vaiorabbit, for tables of unicode ranges (MIT-0).
Rich Geldreich, for miniz (PD).
Ross Williams for lzrw3a (PD).
Samuli Raivio, for bq_websocket (PD).
Sean Barrett, for stb_image, stb_image_write, stb_truetype and stb_vorbis (PD).
Sebastian Steinhauer, for sts_mixer (PD).
Stefan Gustavson, for simplex noise (PD).
Vassvik, for mv_easy_font (Unlicense).
Special thanks to @ands (PD), @barerose (CC0), @datenwolf (WTFPL2), @evanw (CC0), @glampert (PD), @krig (CC0), @sgorsten (Unlicense) and @vurtun (PD) for their math libraries.

Links

Still looking for alternatives? amulet, aroma, astera, blendelf, bullordengine, candle, cave, chickpea, corange, cute, dos-like, ejoy2d, exengine, gunslinger, hate, island, juno, l, lgf, limbus, love, lovr, mini3d, mintaro, mio, opensource, ouzel, pez, pixie, punity, ricotech, rizz, tigr,

r-lyeh-archived/FWK