nene
nene copied to clipboard
The Nene game framework, migrated to codeberg.
Note!
This project moved to CodeBerg!
nene
Nene
it's a little game framework built on top of SDL2
and it's extension libraries (SDL2_image
, SDL2_ttf
, SDL2_mixer
).
Eventually Nene will upgrade to
SDL3
Dependencies
Nene library (runtime, used on games)
These are bundled with Nene
and thus no download it's required, more information below.
- SDL2
2.26.5
- SDL2_image
2.6.3
- SDL2_ttf
2.20.2
- SDL2_mixer
2.6.3
Building Nene library
Installed externally, like on Visual Studio Installer or your system package manager.
- C compiler (tested: Clang, MSVC, GCC)
- CMake
- Git
- Ninja (Optional, but recommended)
Generating Nene bindings
For now this is only expected to work on Linux, better support for Windows will be written, however
bindings are already generated on the repository, thus you don't need to generate them unless you change
Nene
and/or the generators.
- Lua
- Teal
- clang-check
- Bash
To generate bindings:
$ sh genbindings.sh
Building
First, be sure to install a C compiler and CMake.
Note
The following steps were reproduced on Fedora Linux 38
Clone nene
with it's dependencies bundled:
$ git clone https://github.com/Andre-LA/nene.git --recurse-submodules
Generate the building template of CMake:
$ cmake -S . -B build -G Ninja
Note
To use a different C compiler from the default, append the
CMAKE_C_COMPILER
option, example:-D CMAKE_C_COMPILER=clang
whereclang
is the C compiler of choice.
Build Nene and it's dependencies:
$ cmake --build build
To properly organize the files, install it to the local libnene
subdirectory:
$ cmake --install build --prefix libnene
And that's it! Nene development build it's properly done at the libnene
subdirectory.
Usage
Note This section it's still being written.
Examples
Nene doesn't contains a tutorial yet, but you can find some usage examples on the examples
directory:
- Camera
- Pong
- Rects
- Render clip
- Sound and music
- Sprite animation
- Tilemap
- Web
Screenshot with some of the examples above (these shapes are sprites):
License
The license of nene
it's the same as SDL2: zlib license.