skeleton

Simple 2D application framework written in C++/SFML.

Skeleton is a simple framework for creating apps and games using C++ and SFML. It has some tools that make creating new projects easier and faster. It comes with built-in classes such as Buttons, Popups, ResourceManager etc. so you can focus on other aspects of creating your app and stop worrying about creating GUI components or playing sounds - Skeleton has it all!

Brief overview of Skeleton's modules and most important classes

• GUI - Contains all GUI based components
  • Text - Basic sf::Text wrapper with some more functionallity
  • Box - Basic sf::RectangleShape wrapper with some more functionallity
  • TextBox - Combination of Text and Box classes
  • Button - A clickable TextBox with callback
  • InputBox - A box which handles user's input
  • Popup - Can be used as an notifiaction
  • Prompt - Contains InputBox and Buttons and can act as a prompt window
• States - Contains State interface which is used with StateManager
  • FrameworkSplashscreen - an example of state that implements State interface
• Managers - All classes that help with managing the framework resources, states etc.
  • CacheSystem - Manages loading and caching resources such as sf::Texture, sf::SoundBuffer etc.
  • AudioProvider - Uses CacheSystem to play music and sounds (defalut implementation is SFMLSoundProvider)
  • StateManager - Manages State classes. Lets push new States and updates the current state
  • ButtonManager - Manages laying out the buttons, put's them in groups which results in nicely handled keyboard navigation
  • bunch of other Manager classes
• Util
  • Animation - (work in progress) Handles animating of GUI components
  • Random - Random integer/float distribution with range
  • FPSCounter - Useful utility to check the performance
  • Math - Some basic functions that I found helpful in creating SFML apps
• Application - Handles running the app, updating all managers, changing backgrounds etc.

How to build

Skeleton is based on SFML and uses premake5 to build

Download SFML and extract it to the vendor/SFML folder.

Download premake5 and remember it's location or add it to path

Example: Generating Visual Studio 2019 solution and project files

  path/to/premake5.exe vs2019
  // or if the path to SFML is different than default
  path/to/premake5.exe --sfmlpath=path/to/SFML vs2019

Then compile it and run with Visual Studio

Example: Generating Makefiles

  path/to/premake5.exe gmake2
  // or if the path to SFML is different than default
  path/to/premake5.exe --sfmlpath=path/to/SFML gmake2

After that

  make
  // after sucessful compilation
  cd Sandbox
  // it needs to be run from the projects root directory for now
  ..\bin\Debug-windows-x86\Sandbox\Sandbox.exe

Keep in mind that path to the downloaded SFML must be relative to the premake5.lua script

Other platforms and project files

For generating other project files or for different platforms head to this link