aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Config.h
blob: 5bd6913c37637b1fd77ccbd46312f3e8e88c0093 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#pragma once

#include "../util/Log.h"

namespace crepe {

/**
 * \brief Global configuration interface
 *
 * This class stores engine default settings. Properties on this class are only supposed to be
 * modified *before* execution is handed over from the game programmer to the engine (i.e. the
 * main loop is started).
 */
struct Config final {
	//! Retrieve handle to global Config instance
	static Config & get_instance();

	//! Logging-related settings
	Log::Config log;

	//! Save manager
	struct {
		/**
		 * \brief Save file location
		 *
		 * This location is used by the constructor of SaveManager, and should be set before save
		 * manager functionality is attempted to be used.
		 */
		std::string location = "save.crepe.db";
	} savemgr;

	//! physics-related settings
	struct {
		/**
		 * \brief gravity value of physics system
		 *
		 * Gravity value of game.
		 */
		double gravity = 1;
	} physics;

	//! Asset loading options
	struct {
		/**
		 * \brief Pattern to match for Asset base directory
		 *
		 * All non-absolute paths resolved using \c Asset will be made relative to
		 * the first parent directory relative to the calling executable where
		 * appending this pattern results in a path that exists. If this string is
		 * empty, path resolution is disabled, and Asset will return all paths
		 * as-is.
		 */
		std::string root_pattern = ".crepe-root";
	} asset;
};

} // namespace crepe