Gyaszmat

Gyaszmat is a C++ SFML platformer game with lot of love put in to it.

Roadmap: https://trello.com/b/wMSF3RLJ/gyaszmat

Setting up Development Environment

Note: Currently only Windows is regularly tested and supported.

Windows

Setup the environment

1. Download and install Visual Studio 2022 with cmake
2. Also download and install the latest cmake seperately
3. Open project in Visual Studio, it should parse everything.

Build

Just press the build all button in Visual Studio.

Execution

Just press the play button

Ubuntu

Setup the environment

1. Install these:

sudo apt install libssl-dev autoconf libtool pkg-config libx11-dev libxrandr-dev libxi-dev libudev-dev libgl1-mesa-dev udev

2.. Download the latest cmake source, build and install it.

Build

Run the build.sh script from the Project root directory.

Run

Run the run.sh script from the Project root directory.

Coding Guidelines

Naming Conventions

Use app hungarian notation for members and statics. Temporary variable names prfered to be short and understandable. Naming scheme:

• LongClassName
• longLocalVariableName
• m_LongPrivateMemberName
• longPublicMemberName
• s_LongStaticVariableName
• longFunctionMethodName()

Other rules

• Only create struct if all member is public. In this case you dont have to use the m_ prefix.
• Structure a class in this order: public methods / public variables / private methods / private members.
• Use pragma once instead of include guards

If any question: https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md