laguna1989 / jamtemplatecpp

This is the JamTemplate for kickstarting your gamejam entry. It will compile C++20 code for native (Win, Linux, Mac) and web (webassembly) games.

JamTemplateCpp

About

This is the JamTemplate for kickstarting your gamejam entry. It will compile C++20 code for native (Win, Linux) and web (webassembly) games. Internally it uses SFML, SDL and OpenALpp.

Some games created with this JamTemplate are

• Fruit Lovin Monkey Pirates (Action Sailing Game, Native & Web, FrankenGameJam 2023)
• Medibellum (Multiplayer Autobattler Game, Native, Kajam-13 2023)
• Mines of Gloria (Incremental Clicker Game, Native & Web, ClickerJam Spring 2023)
• Tworld (Jump and Run, Native & Web, FrankenGameJam 2022)
• Funky Trip (Top Down ARPG, Native & Web, Alakajam 14 2022)
• Gemga (Puzzler, Native & Web, FrankenGameJam 2021)
• Quasar Rush (Physics based puzzle game, Native & Web, A Game By Its Cover 2021)
• Space Turtles (Multiplayer SHMUP, Native, MultiplayerKajam 2021)
• Tricky Tractor (Puzzler, Native, FrankenGameJam 2020)
• Burning Glyphs (FPS, Web, 7DFPS 2020)
• Grounded (2 Player Couch Battle, Native, FrankenGameJam 2019)

and more at my game portfolio.

Setup

Visual Studio

1. create build directory build at root level
2. open command line (win+r cmd)
3. navigate to the just created build folder
4. type cmake ../
5. Open generated solution file with Visual Studio

Clion (Win, Linux)

1. open project folder in clion

Building for Web

I run it with WSL2, but every system capable of running webassembly / emscripten should work.

Preconditions:

• have emscripten set up on your machine: See the Getting started page

Setup

1. emcmake cmake -DJT_ENABLE_WEB=ON ../
2. on the first run emmake make (do not pass -j, otherwise emscripten will get stuck with pulling libraries)
3. on consecutive runs: emmake make -j
4. http-server . to start a webserver locally. (needs to be installed separately)
5. open browser on http://127.0.0.1:8080/ to test locally

Mac

For mac os you have to install cmake and sfml via homebrew: brew install cmake sfml If you use another package manager or want to install the dependencies yourself, you have to modify the paths in CMakeLists.txt.

Deployment

Automatic creation of the files is automated via github actions. If a release is created with semantic versioning ( e.g. v1.2.3), a deployment build is triggered, which builds the game executable for windows, linux, mac and web and attaches the zipped files to the release once the build is finished. The archives can directly be uploaded on itch, gamejolt or any other website.

Note: Only the game executable and the assets folder is included in the archive. If more files are required, either adjust the deployment script (.github/workflows/deploy.yml) or place them in the assets folder.

CMake options

The options can be set to ON or OFF via the cmake commandline or cmake-gui:

• JT_ENABLE_UNITTESTS - Enables gtest and the unit tests
• JT_ENABLE_PERFORMANCETESTS Enables the performance tests
• JT_ENABLE_DEMOS - Enables the demos (small example programs which showcase a specific theme)
• JT_ENABLE_WEB - Webbuild
• USE_SFML - If ON, SFML will be used, if OFF, SDL will be used (SDL works best on linux)
• JT_ENABLE_AUDIO_TESTS - Some of the tests rely on a working audio setup, which seemingly cannot be faked easily. This switch disables those specific tests, in case no audio is available on the respective machine.
• JT_ENABLE_CLANG_TIDY - Enable clang tidy checker
• JT_ENABLE_LTO_OPTIMIZATION - Enable Link time optimization. This gives higher runtime performance for the cost of increased build and link times.

e.g. calling cmake ../ -DJT_ENABLE_UNITTESTS=ON -DENABLE_DEMOS=ON

Code Coverage

Code Coverage is reported via CodeCov

A local run (without the artifacts) can be executed e.g. on Windows via OpenCppCoverage:

OpenCppCoverage.exe --sources C:\projects\JamTemplateCpp\* --excluded_sources C:\projects\JamTemplateCpp\test\* --excluded_sources C:\projects\JamTemplateCpp\ext\* --excluded_sources C:\projects\JamTemplateCpp\cmake-build-debug\* .\cmake-build-debug\test\unit\jt_test\jt_tests.exe

Performance benchmark

Please check the performance benchmark report.

1hgj setup (recommended steps)

• Use this repo as a template
• Clone the new repository
• Remove the folders
  • test
  • assets/test
  • .github/workflows/ everything except deploy.yml
• Changes in CMakeLists.txt:
  • Set the project name
  • Remove or comment the line add_subdirectory(test)
• Change js filename in index.html
• Set most cmake variables to OFF in config/cmake/cache_variables.cmake
• Import a new palette into impl/gamelib/game_properties.cpp, e.g. from this website ( save as gpl and paste file content)
• Change impl/gamelib/game_properties.hpp settings as needed (window size, jam, author and date)

jamtemplatecpp's Issues

animation looping per animation

currently looping anymiations are either looping all sub animations or none. The user should be able to set this for individual animations.

imgui sdl input

Imgui needs to handle input from sdl.
Problem with https://github.com/ocornut/imgui/blob/master/backends/imgui_impl_sdl.cpp is that it includes SDL and not SDL2/SDL

StressTest implementation

StressTest:

• 👍 Tweens
• 👍 Smart Object functionality (e.g. flash)
• 👍 StateChances
• 👍 Animations

TweenColor

Tweening from color a to color b

Timer in Hud for Template

TweenPosition

Tweening positions should be possible.

Fix screenshake differences between build.

behaves differently on web and windows build

Stresstest Particles

Rename all folders and files to lower case

To avoid os dependent issues with include paths, rename all relevant files and folders to lower case.

texture manager replace color

imgui block input to game when in ui

Use Ninja as Generator for Github Actions

Ninja builds seem to be quite fast compared to Makefile builds.

SmartObject Offset Functionality

Add Offset Functionality for drawing

Dedicated sdl build

Will most likely just require a cmake switch, which graphics lib shall be used. All unit tests should work with SFML and SDL

add clang-tidy to toolchain

perhaps as separate github actions check

automatically pull and deploy openal.dll for windows build

Tween: onCompletion callback

performing an option whenever a tween finishes.

SmartText

Another child class of SmartObject, working on SmartText

Dither vignette

Add SoundManager/Mixer

• Global Mute
• Global Volume
• Different Channels can be assigned to sounds.

sfml text align for multiline text

Multiline text defintion:

• jt::Text
• contains at least one "\n"

This behaves differently for SFML (code) and SDL (code) builds due to differences between the implementations. SFML considers the full text box, while SDL considers each line (which results in the proper result)

Possible solution

• Change the SFML implementation class to contain a vector of sf::Text objects instead of only one. One sf::Text per line.
• Text needs to be split on linebreaks.
• Make the doUpdate() function set the position of the individual sf::Text objects depending on the width of the longest line and the m_textAlign value.
• Make the doDraw() functions (including flash and shadwo) draw those multiple sf::Text objects.

Please check

• Adapt the Scroll/MoveCam demo to contain multiline text with different alignments
• Check that all unit tests pass
• Check that new code branches are tested. This might require some additions to the text_test and potentially the drawable_impl_test
• Check/Adapt the state_menu if needed.

Animations

Implement an animation class, based on smartsprites.

complete line functionality

rotate, flash, is still missing

• sfml
• sdl

check out automatic itch.io publish

https://github.com/marketplace/actions/itch-io-publish

Tween: StartDelay

Add startDelay to tweens

automatic deployment of game to gh-pages

For clang, remove -stdc++fs flag

Add version information in deployment script

e.g. by having one file with a constexpr string GAMEVERSION which can be replaced by the tag version and printed in the main menu

Load non rectangular objects from tileson

Create Stresstest that runs automatically and measures performance

music with intro/loop

create a helper class that will play a intro part once and a looping part afterwards.

Advanced Palette functions

• Add Functions to easily manipulate colors, e.g.
  • desaturate() #184
  • saturate
  • rotate hue
  • darken
  • lighten
• Palette from image
  • Load a jt::Sprite and use getColorAtPixel to fill a Palette.
  • The Palette class should get a new static function that acceppts the filename to an image and returns the respective Palette
• Extend demos
• Works for both SFML and SDL
• MakeUnique

Timer finish() and cancel()

The timer class should have a finish and cancel functionality

Change deployment workflow to work on tags and not on a specific branch

automatically convert sounds that are not 44.1 kHz (or audio context's sampling rate)

separate game into library and main to allow for testing of game classes in separation

investigate shaders

SFML seems pretty simple:
https://www.sfml-dev.org/tutorials/2.5/graphics-shader.php

SDL not so much (As always)

• https://github.com/erik-larsen/emscripten-sdl2-ogles2/blob/master/src/hello_triangle.cpp
• https://github.com/Acry/SDL2-OpenGL/blob/master/src/1.c
• https://github.com/AugustoRuiz/sdl2glsl
  -> It seems like sdl does not support shaders when using the sdl_renderer. SDL_GPU sounds like a possible solution

gamepad support

update readme.md

Tweens: Split to different Files

to reduce complexity

Rework Object Group

• Do not derive from std::vector because of the reasons listed here
• Clean up object group unit tests

Color and Palette functionality

Colors currently only support rgb.

• hsv2rgb
• rgb2hsv
• Add hexString support #93
• Add random functions to get a color with a fixed saturation or hue #100
• Add Palette class to group colors together and manipulate them together #100
• Palette from gpl #102
• Add Demo #102

SmartObject warning when calling draw without a previous update

that "bug" cost me 10 minutes on 1hgj.

Does Tween need to inherit from GameObject?

See game_state.hpp

SmartObjects: Add rotate functionality

Rotating Sprites, Shapes and Text might be a thing.
Also make sure to take care of rotation center correctly.

Add Ease functions

Add ease functions http://robertpenner.com/easing/

Implement convenient Box2D interface

Setting Up

Make setting up the game class in main.cpp easier

New Demo for showcasing game state transitions

TweenScale

Tweening the Scale should be possible.