Skip to main content

Contributing

warning

Make sure you check CONTRIBUTING.md on github

WINDOWS Setup​

REQUIRED SOFTWARE​

  • GIT or something similar to GIT
  • CMAKE at least > 3.16.3
  • Download and install C++ Build Tools (2022 is recommended)
  • Download and install a IDE, Visual Code is recommended.
  • Download and setup ninja (make sure it's in the enviroment path)
    • pip install ninja if you have python3 installed

IDE SETUP (Visual Code)​

  • Open the workspace file (.code-workspace) and install the recommended extensions (at least C++ & CMAKE)
  • Run cmake configure
  • Select [Visual Studio Build Tools <version> Release - amd64] on the kit popup (for all of the projects)
  • Run the compiler by hitting F5

LINUX Setup​

REQUIRED SOFTWARE​

IDE SETUP​

  • TODO

CMAKE Setup

Ensure RAWRBOX_DEV_MODE is enabled. This will build all the libraries while compiling the engine