KCNet-SFML-GameTest

I am working on a basic game in SFML using C++ in this repo.

Info

This just has a player that can move around, some game music, and falling enemies to dodge.

The player can now lose lives when the enemies hit them, although it is sometimes delayed or too fast.

I will most likely add a resume button, options, and quit later on for the pause menu.

So far, this has no textures or sprites and I'm just using sf::RectangleShape for the enemies and player for now, it's just a demo for me to experiment with and learn more SFML and C++.

Features

Pause Menu

You can press Escape to view the pause menu, so far you can toggle the music on/off but it doesn't update the status display in game without a restart of the game.

Player

The player by default has 3 lives.

Score

The score is set to increase by 1 every second, runs on a timer.

Rounds

The rounds go up by 1 every 30 seconds by default, this can be setup in the game-settings.ini file.

End screen

This game has an end screen when the player dies, it shows your total score, and you can restart by pressing enter on this screen.

Config

This uses SimpleIni for handling the config, there is a few settings that can be changed in the game-settings.ini file, and I will be adding more to this later.

Debug Menu

I have a debug menu setup with ImGui, use the F2 key to open/close it in game.

Quick start

Command line

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

2. Follow GitHub's instructions for how to use their project template feature to create your own project.

3. Clone your new GitHub repo and open the repo in your text editor of choice.

4. Open CMakeLists.txt. Rename the project and the target name of the executable to whatever name you want. Make sure to change all occurrences.

5. If you want to add or remove any .cpp files, change the source files listed in the add_executable call in CMakeLists.txt to match the source files your project requires. If you plan on keeping the default main.cpp file then no changes are required.

6. If your code uses the Audio or Network modules then add SFML::Audio or SFML::Network to the target_link_libraries call alongside the existing SFML::Graphics library that is being linked.

7. If you use Linux, install SFML's dependencies using your system package manager. On Ubuntu and other Debian-based distributions you can use the following commands:

   sudo apt update
   sudo apt install \
       libxrandr-dev \
       libxcursor-dev \
       libxi-dev \
       libudev-dev \
       libfreetype-dev \
       libflac-dev \
       libvorbis-dev \
       libgl1-mesa-dev \
       libegl1-mesa-dev \
       libfreetype-dev
   

8. Configure and build your project. Most popular IDEs support CMake projects with very little effort on your part.

   • VS Code via the CMake extension
   • Visual Studio
   • CLion
   • Qt Creator

   Using CMake from the command line is straightforward as well. Be sure to run these commands in the root directory of the project you just created.

   cmake -B build
   cmake --build build
   

9. Enjoy!

Visual Studio

Using a Visual Studio workspace is the simplest way to get started on windows.

1. Ensure you have the required components installed.
2. Follow GitHub's instructions for how to use their project template feature to create your own project.
3. If you have already cloned this repo, you can open the folder.
4. If not, you can clone it directly in Visual Studio.

Visual Studio should automatically configure the CMake project, then you can build and run as normal through Visual Studio. See the links above for more details.

Upgrading SFML

SFML is found via CMake's FetchContent module. FetchContent automatically downloads SFML from GitHub and builds it alongside your own code. Beyond the convenience of not having to install SFML yourself, this ensures ABI compatibility and simplifies things like specifying static versus shared libraries.

Modifying what version of SFML you want is as easy as changing the GIT_TAG argument. Currently it uses SFML 3 via the 3.0.2 tag.

To Run

If downloading from the source:

1. Download SFML from here for the DLLs on Windows: https://www.sfml-dev.org/download/sfml/3.0.2/
2. Extract that file somewhere

If using Debug build mode, copy the sfml-d.dll files to ./x64/Debug, 

if using Release build mode.copy the files without the -d to ./x64/Release

Libraries used

This is a list of libraries in use for this C++ game project.

These are obtained from the dependencies folder, which has a CMakeLists.txt file to read from.

• Fmt - For formatting text and printing (https://github.com/fmtlib/fmt)
• ImGui - ImGui menu dependency (https://github.com/ocornut/imgui)
• SpdLog - For logging system (https://github.com/gabime/spdlog)
• SimpleIni - For the config system/ini handling (https://github.com/brofield/simpleini)
• SFML - Main game engine (https://github.com/SFML/SFML.git)
• SFML-ImGui - ImGui debug menu for SFML (https://github.com/SFML/imgui-sfml.git)

Credits

None of this would be possible without the team at SFML, this is using their libraries and window system:

• https://github.com/SFML/SFML/

I would like to thank the author of this youtube series for a lot of help with learning SFML:

• https://www.youtube.com/playlist?list=PL6xSOsbVA1eb_QqMTTcql_3PdOiE928up

The CMake SFML template was originally from the SFML team on GitHub:

• https://github.com/SFML/cmake-sfml-project

License

This project is licensed under the MIT license.