ConfettiFX / The-Forge

The Forge Cross-Platform Rendering Framework PC Windows, Steamdeck (native), Ray Tracing, macOS / iOS, Android, XBOX, PS4, PS5, Switch, Quest 2
Apache License 2.0
4.8k stars 501 forks source link

How do i build The Forge? #123

Closed AlastairGrowcott closed 5 years ago

AlastairGrowcott commented 5 years ago

I cannot find any build instructions. I am building on Linux. I have installed CodeLite, run the PRE_BUILD.command script and when I try to run PyBuild.py I get hundreds of errors, starting with:

Executing command: codelite-make -w VisibilityBuffer.workspace -p VisibilityBuffer -c Debug

[ERROR ] Could not load build settings configuration object (Version 2.1 / build_settings.xml)

Executing command: make -s

make: *** No targets specified and no makefile found. Stop. ('FAILED BUILDING ', 'VisibilityBuffer.workspace/VisibilityBuffer', 'Debug')

I have no idea how to use CodeLite but after realising it was an IDE (ugh!) I ran it, did the setup wizard and tried to open an existing workspace - there isn't one in the top level directory.

What wouldn't I give to just see a CMakeLists.txt file in the top level directory!

wolfgangfengel commented 5 years ago

Just use the solution file. Can you find it?

wolfgangfengel commented 5 years ago

You want to look into this folder:

https://github.com/ConfettiFX/The-Forge/tree/master/Examples_3/Visibility_Buffer/UbuntuCodelite

wolfgangfengel commented 5 years ago

If you bump into problems, let me know, I can also make you part of a support forum. Please note we only test what is in our Linux requirement list ...

AlastairGrowcott commented 5 years ago

Thanks. I'll try to find time to give this a go today.

Am i right in thinking that this workspace will build just the engine and one example?

Is there any documentation on the API for this engine?

I'd also like to extract the libraries and headers from the build tree to use in my own project. Is there some sort of "install" build target for this?

AlastairGrowcott commented 5 years ago

That built and ran fine.

The cushions on the upper terrace fuzz a bit like white noise on an analogue TV when the camera is moving, but otherwise that is a pretty awesome demo.

wolfgangfengel commented 5 years ago

Great! I will close this then.