fruitwork is a simple component-based game engine written in C++ and the SDL2 library.
fruitwork is using a slightly modified version of the LLDB naming conventions (taken from & modified in CLion). The differences are as follows:
- Camel case is used for global/local variables and parameters.
- Namespace members are indented by 4 spaces.
- Switch cases are always on a new line (
Keep simple cases in one line = false) - Header guards are in the format
FRUITWORK_<FILENAME>_H.
fruitwork uses Makefiles to build the project, which can be found at its root. The Makefile uses the following project structure:
.
├── build/
├── fruitwork/
│ ├── include/
│ ├── resources/
│ ├── src/
│ └── Makefile
└── project/
├── include/
├── resources/
└── src/
Both fruitwork and the project use their own directory resources/. Both are copied to the build/ directory when building the project. If a file with the same name exists in the project's resources/ directory, it will be copied over the one in the fruitwork/ directory.
fruitwork have a few resources that are required for the engine to work, that can be found in the fruitwork/resources/ directory. They can be overridden by just adding the same file to the project's resources/ directory, or replacing the file in the fruitwork/resources/ directory.
The scene system is based on Unity Scenes and Finite state machines, the latter explained by Lazy Foo' Productions. Various StackOverflow answers are attributed in the code.