Skip to content

build_scripts.md

Latest commit

 

History

History
65 lines (45 loc) · 1.17 KB

build_scripts.md

File metadata and controls

65 lines (45 loc) · 1.17 KB

Build Scripts

The helper scripts live in Engine/. They are optional, but they are the fastest way to get a repeatable local build.

build.sh

Run from Engine/:

./build.sh [--no-vcpkg] [gcc|clang] [Debug|Release] [-- <extra cmake args>]

What it does:

  • Configures with -S "$SCRIPT_DIR" and an out-of-tree build under Engine/Bin/.
  • Enables module scanning flags.
  • Tries to discover VCPKG_ROOT automatically unless --no-vcpkg is used.
  • Builds the target and generates API docs when Doxygen is available.

Examples:

cd Engine
./build.sh gcc Release
./build.sh --no-vcpkg clang Debug -- -DEPOCH_ENABLE_RAYLIB=OFF

run.sh

cd Engine
./run.sh [gcc|clang] [Debug|Release] [-- <runtime args>]

The script launches the epoch runtime from the matching Engine/Bin/... output directory.

install.sh

cd Engine
./install.sh [gcc|clang] [Debug|Release]

Installs to Engine/built/bin/<Compiler>-<Config>.

clean.sh

cd Engine
./clean.sh

Removes:

  • Engine/Bin/
  • Engine/build/
  • Engine/built/
  • top-level CMake cache/state under Engine/

Related docs

  • build_presets.md
  • tools_list.md