small3d

[Source Code] [API Documentation]

Minimalistic, open source library for making 3D games in C++, with Vulkan and OpenGL support

Sample games

• Avoid the Bug
• Chase the Goat
• Frog Remixed
• Gloom

If you prefer building with conan.io, these two repositories contain games that can be built that way:

• Gloom for conan
• Islet Hell

Tutorial

https://www.gamedev.net/tutorials/programming/engines-and-middleware/small3d-tutorial-r5655/

Features

• 3D models loaded from glTF (glb) or Wavefront (obj) files
• Other customised meshes and shapes
• Animation
• Texture mapping
• Gouraud shading
• Image rendering
• Font rendering
• Sound
• Collision detection

Supported platforms

• Windows
• MacOS
• Linux (tested on Debian, Ubuntu and Fedora)
• Android
• iOS

Building prerequisites

The following need to be installed, with the relevant environment variables and tools accessible via the command line:

• Some compiler, gcc, Visual Studio, clang, etc.
• Vulkan SDK (if it will be used)
• 7zip (only on Windows)
• CMake

Building and deploying

Run the build script which is suitable to your platform from the scripts directory (build-vs.bat, build-mingw.bat or build.sh)

Then, the unit tests can be run via the unittests binary from build/bin.

If any of this fails or you would simply like to restart the building procedure, the best way to clean the small3d directories is by using git:

git clean -fdx

For building your own project, you need:

• The header files from the build/include directory
• The libraries from the build/lib directory
• The shaders from build/shaders directory

If you are using cmake, the modules in small3d/cmake can be useful. Check the CMakeLists.txt and src/CMakeLists.txt files for other configuration details (link flags, etc) that may also be required or useful.

Deploying with conan

For deploying small3d with conan.io, first add the Barbarian package index:

conan remote add barbarian-github https://barbarian.bfgroup.xyz/github

You can then reference the small3d library as small3d/master@dimi309/small3d in your conanfiles.

If you would like to export and set up the small3d package locally yourself, the conan configuration can be found in the conan_io subdirectory of this git repository.

small3d on mobile

You can build small3d for mobile platforms by executing either build-android or build-ios from the scripts directory. One sample game, Avoid the Bug has been ported to both Android and iOS. I use these projects as a basis for mobile development. Note that, while with the desktop edition of small3dI use GLFW for windowing functionalities and I/O, on mobile I access the native infrastructure directly.

Referenced libraries

All small3d dependencies, apart from the Vulkan SDK, are distributed together with its source code. They can be built by executing a single script (see "Building", above).

• Vulkan SDK, or glew if building for OpenGL
• glfw
• glm
• png
• zlib
• ogg
• vorbis
• portaudio
• freetype
• bzip