forked from OpenRA/OpenRAModSDK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mod.config
107 lines (85 loc) · 4.23 KB
/
mod.config
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
##############################################################################
# Core Configuration
#
# Basic settings that should be changed by all projects.
##############################################################################
# The id of the mod packaged by this project.
# This must exist as a directory in the mods directory and should not contain spaces.
MOD_ID="example"
# The OpenRA engine version to use for this project.
ENGINE_VERSION="release-20180218"
# Enable this to make the default OpenRA mods available for use in your mod.yaml
# Packages list (via $mod references). Accepts values "True" or "False".
# WARNING: This setting is provided to simplify early project development,
# and must be disabled before you can package installers for your project!
INCLUDE_DEFAULT_MODS="False"
##############################################################################
# Continuous Integration
#
# Settings controlling the behaviour of Travis CI
# (if it has been enabled on your GitHub repository)
##############################################################################
# Enable tests for common errors when a new commit is pushed to the GitHub repository
# Accepts values "True" or "False".
TRAVIS_TEST_MOD="True"
# Perform a dry run of the installer generation when a new commit is pushed to the GitHub repository
# Accepts values "True" or "False".
TRAVIS_TEST_PACKAGING="False"
##############################################################################
# Packaging
#
# Settings controlling the creation of installers.
##############################################################################
# The prefix used for the installer filenames.
# - Windows installers will be named as {PACKAGING_INSTALLER_NAME}-{TAG}.exe
# - macOS installers will be named as {PACKAGING_INSTALLER_NAME}-{TAG}.zip
PACKAGING_INSTALLER_NAME="ExampleMod"
# The human-readable name for this project.
# This is used in:
# - Crash dialogs (all platforms)
# - macOS .app bundle name
# - macOS menu bar
# - macOS "About" window
# - Windows installer
# - Windows start menu
# - Windows desktop shortcut
# - Windows "Programs and Features" list
PACKAGING_DISPLAY_NAME="Example Mod"
# The URL for the project homepage.
# This is used in:
# - Windows "Add/Remove Programs" list
PACKAGING_WEBSITE_URL="http://openra.net"
# The URL that is opened when a player presses the "FAQ" button in the crash dialog.
PACKAGING_FAQ_URL="http://wiki.openra.net/FAQ"
# The human-readable project authors.
# This is used in:
# - Windows "Add/Remove Programs" list
PACKAGING_AUTHORS="Example Mod authors"
# The git tag to use for the macOS Launcher files.
PACKAGING_OSX_LAUNCHER_TAG="osx-launcher-20171118"
# Filename to use for the launcher executable on Windows.
PACKAGING_WINDOWS_LAUNCHER_NAME="ExampleMod"
# The name of the Windows Program Files directory to install the project files to.
PACKAGING_WINDOWS_INSTALL_DIR_NAME="OpenRA Example Mod"
# The key prefix used for Windows registry metadata.
# This should not contain spaces or special characters.
PACKAGING_WINDOWS_REGISTRY_KEY="OpenRAExampleMod"
##############################################################################
# Advanced Configuration
#
# Most projects will not need to modify these
##############################################################################
# Automatic engine managment will treat the OpenRA engine files like a read-only dependency.
# Disable this if you would like to modify or manager your own engine files.
AUTOMATIC_ENGINE_MANAGEMENT="True"
# The URL to download the engine files from when AUTOMATIC_ENGINE_MANAGEMENT is enabled.
AUTOMATIC_ENGINE_SOURCE="https://github.com/OpenRA/OpenRA/archive/${ENGINE_VERSION}.zip"
# Temporary file/directory names used by automatic engine management.
# Paths outside the SDK directory are not officially supported.
AUTOMATIC_ENGINE_EXTRACT_DIRECTORY="./engine_temp"
AUTOMATIC_ENGINE_TEMP_ARCHIVE_NAME="engine.zip"
ENGINE_DIRECTORY="./engine"
# The url to download the OpenRA macOS launcher files.
PACKAGING_OSX_LAUNCHER_SOURCE="https://github.com/OpenRA/OpenRALauncherOSX/releases/download/${PACKAGING_OSX_LAUNCHER_TAG}/launcher.zip"
# Temporary file name used when downloading the OpenRA macOS launcher files.
PACKAGING_OSX_LAUNCHER_TEMP_ARCHIVE_NAME="launcher.zip"