Awesome
Empty project
This is empty project that used the Framework as submodule.
It demonstrates the absolute minimum of code that is necessary to render something on the screen on Desktop platforms.
Mobile and Web platforms have their quirks and require additional code to work.
Building the Project and the Framework from source
This option has longer build times but you can easily modify the engine.
- Checkout the Framework as
rbfx
directory anywhere, if you didn't do that already. - Checkout this repository near
rbfx
directory. - Configure and build it via CMake. For example:
cd path/to/project
cmake . ./cmake-build
cmake --build ./cmake-build -j12
Building the Project with pre-built Framework SDK
This option has shorter build times but you have to use pre-built version of the engine.
- Download pre-built SDK of the Framework for your platform and compiler anywhere.
- Checkout this repository anywhere.
- Configure and build it via CMake. Variable
REBELFORK_SDK
should be set to the folderSDK
from within the zip archive. Example:
cd path/to/project
cmake . ./cmake-build -DBUILD_SHARED_LIBS=ON -DREBELFORK_SDK=path/to/prebuilt/SDK
cmake --build ./cmake-build -j12
If pre-built SDKs available on GitHub are not suitable for you, you can build the Framework as SDK on your own. Check documentation for build instructions.
Running the Sample
Just run EmptyProject.exe
on Windows or EmptyProject
on Linux.
Make sure that rbfx/bin/CoreData
is visible by the executable.
It is usually copied automatically by CMake, but if it doesn't, you can copy it manually.
Alternatively, you can run EmptyProject
executable with --pp path/to/bin
command line argument
to specify the path to the directory containing CoreData
.