Quickstart¶

Setting up an example project¶

If you don’t have portal-tool insalled, please refer to Installation

portal-tool has an interactive wizard to help you setup your project.
Simply run:

portal-tool init

Init Wizard Questions¶

Calling portal-tool will ask you a few questions to help you setup your project.

Question	Description	Default	Example
Project Name	The name of the project	No Default	`My Project`
Base Location	The path to create that project at	`CWD` / Project name as snake case	`my-project`
Use Example?	Whether or not to use and example to configure the project	Y/N question	y
Example to use	If answered yes, shows a list of examples to use	`engine_test`	`engine_test`
Use External VCPKG?	If installed, will ask if you want to use an externally installed vcpkg to add a submodule	Y/N question	n
Choose Compiler	Will show you a list of installed valid compilers and ask you which one you want to use	`clang` if exists	`clang`

Project Structure¶

After init is finished, you will have a project structure similar to this:

project-name
├───cmake/
│   └───overlay-triplets/     # Triplets overload for build system
├───resources/                # Resources for this project
├───source/                   # Source code for this project
├───CMakeLists.txt            # CMakeLists.txt with basic setup
├───CMakePresets.json         # Common presets
├───settings.json             # Settings for portal framework
├───vcpkg.json                # vcpkg manifest
└───vcpkg-configurations.json # vcpkg registry configurations

Building And Running¶

Portal Tool¶

Portal tool comes with cli tools to build and run the project. To run the editor, enter your project’s directory and run:

portal-engine editor

This will build and start the editor in development build configuration. See the help menu for more options.

To run the runtime, use:

portal-engine runtime

Note

portal-engine is a utility cli that is installed alongside portal-tool, if portal-tool works for you, so should portal-engine!

Manual¶

Under the hood, portal-tool uses cmake to build the project.

Configuration¶

The default cmake generator is Ninja Multi-Config. to run it, use:

cmake --preset ninja-multi

This will create a build folder with the configurations for all build presets

Building¶

The default build presets are debug, development and dist.

debug - debug build will build the project in debug with asserts and debugging symbols enabled
development - development build will build the project in release with asserts and debugging symbols enabled
dist - dist build will build the project in release with asserts disabled and debugging symbols disabled

To build a specific preset:

cmake --build build --preset <debug/development/dist>

Running¶

Editor¶

By default, you can find the editor in build/ninja-multi/<Configuration> folder, the editor is expects to run from the project root dir, or be provided with the -p argument, which will specify the project root dir.

Runtime¶

The runtime executable is located in build/ninja-multi/<Configuration> as well, unlike the editor it expects to run from its bin dir, he searches for the resources file installed alongside it.

Packaging¶

Installer Package¶

The installer requires the QT Installer Framework, you can download it here

You need to configure the installer using portal_game_configure_installer cmake command. Then run:

cmake --workflow package-installer

This will create an installer package in the dist folder.

Note

Make sure to add the Qt Installer Framework to your PATH!

Zip Package¶

There are no additional steps required to create a zip package, Simply run:

cmake --workflow package-zip

This will create a zip with the binaries in the dist folder.