███████ █████ ██ ████████ ██████ ███ ███ ██████ ██ ████ ████████ ██████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███████ ██ ██ ██ ██ █████ ██ ███ ██ ██████ ██ ██████ ██ ██████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███████ ██████ ██████ ██ ██████ ██ ██ ██ ██████ ██ ██ ██ ██████
◎ A Base Project Setup for SDL/ImGui
C++ Rendering/Graphics project template with SDL and Dear ImGUI.
Table of Contents
This repository template should allow for a fast and hassle-free kick start of your next SDL project using CMake. Thanks to GitHub's nature of templates, you can fork this repository without inheriting its Git history.
The template starts out very basic, but might receive additional features over time:
- Basic CMake script to build your project and link GLFW on any operating system
- Basic GitHub Actions script for all major platforms
C++ SDL project template with Dear ImGUI, and SDL 3. This repository is a template OpenGL project configured using CMake. It supports cross-platform builds, and provides a good starting point to begin SDL development.
- Prototyping
- Getting started with game programming
- Getting started with graphics programming
- Modular project structure: sources, headers, and entry points are organized in distinct folders for clarity and scalability.
- Modern CMake build system for easy, cross-platform compilation and dependency management.
- Out-of-the-box support for SDL3, Dear ImGui.
- Continuous integration via GitHub Actions for automated builds and testing.
- Example code for window creation, rendering loop, and GUI integration.
- Easily extensible for additional libraries or custom modules.
- Cross-platform: Windows, Linux, and macOS support.
- Optional support for Conan for advanced dependency management.
- Ready-to-use template for rapid prototyping, game development, or graphics research.
This project leverages several modern libraries and tools to streamline development, building, and documentation.
| Library | Purpose | Details |
|---|---|---|
| SDL | Window/Renderer | Cross-platform renderer |
| ImGui | Graphical User Interface | Immediate Mode Graphical User Interface |
| Compiler | Platforms | Minimum Version |
|---|---|---|
| Clang | Linux/Windows/MacOs | 10 |
| MSVC | Windows Only | 2019 |
| GNU/MinGW | Linux/Windows/MacOs | 9 |
- Git – Version control and submodule/dependency management
- Doxygen – (Optional) Generate code documentation
- Ninja – (Optional) Faster alternative build backend for CMake
- Conan for install packages (optional)
Using CMake
Configuring and Building
Using Make
Configuring and Building
- 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
- 🐛 Report Issues: Submit bugs found or log feature requests for the
SDLTemproject. - 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone --recursive https://github.com/djoezeke/SDLTem
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
- SFMLTem : A SFML Starter Template with SFML and ImGui.
- GLFWTem : A GLFW Starter Template with OpenGl and ImGui.
- CppStarter : A C/C++ Starter Template.
This project is protected under the MIT License. For more details, refer to the LICENSE file.