What a project.json says about the game it describes. More...

#include <project.h>

Public Attributes
std::string	name = "Untitled"
	Display name; titles the window.
std::string	description
	One line on what it is, for the editor's start screen.
std::string	version
	The game's own, which its packages are named by.
std::string	engineVersion
	Engine version this was authored against.
std::string	entryScene
	Scene to boot, relative to the project root.
uint32_t	tickRate = Config::DEFAULT_TICK_RATE
	Simulation ticks per second.
uint32_t	maxPlayers = 10
	How many players this game is for.
uint16_t	netPort = 27750
	The port this game is served on unless a run says otherwise.
std::vector< SplashEntry >	splash
	Logos shown after the engine's own, in the order listed. Usually empty.
RenderSettings	render
	What the game looks like, as the author left it.

Detailed Description

What a project.json says about the game it describes.

A project is a directory with a project.json at its root. engineVersion is compared against the running engine so a mismatch is reported up front.

Member Data Documentation

uint32_t Vkm::Engine::Project::maxPlayers = 10

How many players this game is for.

A property of the game, not of a run. A connection past the last seat is refused with a reason.

uint16_t Vkm::Engine::Project::netPort = 27750

The port this game is served on unless a run says otherwise.

A port given on a host's command line wins over this one.

RenderSettings Vkm::Engine::Project::render

What the game looks like, as the author left it.

Project, not editor, state: it passes ProjectPaths' "would you commit this?". Debug view state is not in here; see visitShippedRenderFields.

The documentation for this struct was generated from the following file: