███████ ██████  ███   ███  ██    ████████ ██████   ███   ███  ██████ ██      ████  ████████ ██████
██      ██     ██ ██ ██ ██ ██       ██    ██      ██ ██ ██ ██ ██  ██ ██     ██  ██    ██    ██
███████ ██████ ██  ███  ██ ██       ██    █████   ██  ███  ██ ██████ ██     ██████    ██    ██████
     ██ ██     ██       ██ ██       ██    ██      ██       ██ ██     ██     ██  ██    ██    ██
███████ ██     ██       ██ ██████   ██    ██████  ██       ██ ██     ██████ ██  ██    ██    ██████

◎ A Base Project Setup for SFML/ImGui

SFML TEMPLATE

C++ Rendering/Graphics project template with SFML and Dear ImGUI.

Table of Contents

• 📍 Overview
• 👾 Features
• 📁 Project Structure
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 🔰 Contributing
• 🙌 Acknowledgments
• 📃 License

📍 Overview

This repository template should allow for a fast and hassle-free kick start of your next SFML 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 SFML on any operating system
• Basic GitHub Actions script for all major platforms

For whom is this for?

• Prototyping
• Getting started with game programming
• Getting started with graphics programming

👾 Features

• Sources, headers and mains separated in distinct folders
• Use of modern CMake for much easier compiling
• Continuous integration via GitHub Actions

---

🚀 Getting Started

1. Install Git and CMake. Use your system's package manager if available.

☑️ Prerequisites

This project leverages several modern libraries and tools to streamline development, building, and documentation.

📚 Libraries

Library	Purpose	Details
ImGui	Graphical User Interface	Immediate Mode Graphical User Interface
SFML	Graphic/Rendering Library	Used for Graphic Rendering
ImGui-SFML	ImGui SFML Binding Library	Bind ImGui and SFML

🧑‍💻 Compilers

Compiler	Platforms	Minimum Version
Clang	Linux/Windows/MacOs	10
MSVC	Windows Only	2019
GNU/MinGW	Linux/Windows/MacOs	9

🛠️ Build Tools

Cmake

Make

Script

🧰 Additional Tools

• Conan for install packages (optional)
• Git for cmake automatic dependencies
• Doxygen for generate documentation (optional)

⚙️ Installation

Using CMake

Configuring and Building

Using Make

Configuring and Building

🤖 Usage

🧪 Testing

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the SFMLTem project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone --recursive https://github.com/djoezeke/SFMLTem

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

🙌 Acknowledgments

References

• GLFWTem : A GLFW STarter Template with OpenGl and ImGui.
• SDLTem : A SDL Starter Template with SDL and ImGui.
• CppStarter : A C/C++ Starter Template.

More Reading

Here are some useful resources to learn more:

• Official CMake Tutorial
• Include ImGui with Conan
• Include ImGui with Vulkan

📃 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.