jubilant-funicular

This is a library to aid in the creation of (2D) games using OpenGL and SDL2. It was originally created while following tutorials on the MakingGamesWithBen youtube channel, but it has since grown into its own library, and so has many differences from the one written in that series. This library is here for me to learn a little about game development.

I am using this library to write this game.

If you are interesting in using this for your own project, then looking in the examples folder may be helpful.

Ideally this entire library would work equally well on Linux, OSX, and Windows. In practice, the code is only tested on Linux, so while I try to keep things OS-agnostic, I cannot promise this is the case. Open an issue if it fails to build on your computer.

For example usage, check out the tests and examples folders. The tests should give you a decent idea of how some (important) library features work, and the examples will let you better see how to put the various aspects of this library together in real code. In particular, I think the dodging boxes example is fun little example of what you can do. It has code for a game played on two screens; The obstacle shows a bunch of balls raining down, and the player screen shows only the player. You have to move left/right to avoid the balls seen on the obstacle screen.

Documentation can be found here.

Requirements

In a perfect world there would be no dependencies and all the necessary code would be written by me; however, in our world you should make sure you have

• OpenGL
  • Glew
  • GLUT
• SDL2
  • SDL2-mixer (Optional)
  • SDL2-ttf
• DevIL (Optional)

All of these can be obtained using apt-get on Ubuntu. If you want to get them all at once, run

sudo apt-get install libsdl2-dev libsdl2-ttf-dev libsdl2-mixer-dev \
    libglew-dev freeglut3-dev libxmu-dev libxi-dev libdevil-dev

You'll likely already have some of these (e.g. libxmu-dev and libxi-dev)

On Mac, you can get them using brew.

If you don't want to use the ones labelled Optional, disable the relevant options in CMakeLists.txt.

Building Library (Along with Examples and Tests)

If you want to build this library in isolation, do the following

git clone https://github.com/NivenT/jubilant-funicular
cd jubilant-funicular
git submodule update --init --recursive
mkdir build
cd build
cmake ../
make

After that, to run all the tests you just need to call make test. The tests are built inside of the tests_bin folder, so if you want to run one individually, then do something like the following (from inside the build folder)

cd tests_bin
./event_tests

The examples have to be run manually (i.e. there's no make example). They are built inside examples_bin, so you can run one by doing something like (from inside the build folder)

cd examples_bin
cd bouncing_balls
./bouncing_balls

Note

There are a few dependencies (none of the ones listed above) that come with the project. In an attempt to limit the repo's size, I've included (parts of) them directly instead of as submodules. These can be found in the deps folder and include

• glm
• Dear Imgui (Optional)
  • Imgui_tabs
• CImg (Optional)