147 lines
6.3 KiB
Plaintext
147 lines
6.3 KiB
Plaintext
##############################################################################
|
|
# 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-20210321"
|
|
|
|
# .dll filenames compiled by the mod solution for use by the runtime assembly check
|
|
WHITELISTED_MOD_ASSEMBLIES="OpenRA.Mods.Example.dll"
|
|
|
|
##############################################################################
|
|
# 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}.dmg
|
|
# - Linux .appimages will be named as {PACKAGING_INSTALLER_NAME}-${TAG}.AppImage
|
|
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
|
|
# - macOS disk image title
|
|
# - Windows installer
|
|
# - Windows start menu
|
|
# - Windows desktop shortcut
|
|
# - Windows "Programs and Features" list
|
|
# - Linux launcher shortcut
|
|
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 displayed 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"
|
|
|
|
# Space delimited list of dll files compiled by the mod, which
|
|
# should be copied from the bin directory into your installers
|
|
PACKAGING_COPY_MOD_BINARIES="OpenRA.Mods.Example.dll"
|
|
|
|
# If your mod depends on OpenRA.Mods.Cnc.dll from the engine set
|
|
# this to "True" to package the dll in your installers.
|
|
# Accepts values "True" or "False".
|
|
PACKAGING_COPY_CNC_DLL="False"
|
|
|
|
# If your mod depends on OpenRA.Mods.D2k.dll from the engine set
|
|
# this to "True" to package the dll in your installers.
|
|
# Accepts values "True" or "False".
|
|
PACKAGING_COPY_D2K_DLL="False"
|
|
|
|
# If you wish to enable Discord integration, register an
|
|
# application at https://discord.com/developers/applications
|
|
# and define the client id here and in your mod.yaml
|
|
PACKAGING_DISCORD_APPID=""
|
|
|
|
# The git tag to use for the macOS Launcher files.
|
|
PACKAGING_OSX_MONO_TAG="osx-launcher-20200830"
|
|
|
|
# The macOS disk image icon positions, matched to the background artwork
|
|
PACKAGING_OSX_DMG_MOD_ICON_POSITION="190, 210"
|
|
PACKAGING_OSX_DMG_APPLICATION_ICON_POSITION="410, 210"
|
|
PACKAGING_OSX_DMG_HIDDEN_ICON_POSITION="190, 350"
|
|
|
|
# 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"
|
|
|
|
# Path to the file containing the text to show in the Windows installer license dialog
|
|
PACKAGING_WINDOWS_LICENSE_FILE="./COPYING"
|
|
|
|
# The git tag to use for the AppImage dependencies.
|
|
PACKAGING_APPIMAGE_DEPENDENCIES_TAG="20200328"
|
|
|
|
# Space delimited list of additional files/directories to copy from the engine directory
|
|
# when packaging your mod. e.g. "./mods/modcontent"
|
|
PACKAGING_COPY_ENGINE_FILES=""
|
|
|
|
# Overwrite the version in mod.yaml with the tag used for the SDK release
|
|
# Accepts values "True" or "False".
|
|
PACKAGING_OVERWRITE_MOD_VERSION="True"
|
|
|
|
##############################################################################
|
|
# 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 mono runtime.
|
|
PACKAGING_OSX_MONO_SOURCE="https://github.com/OpenRA/OpenRALauncherOSX/releases/download/${PACKAGING_OSX_MONO_TAG}/mono.zip"
|
|
|
|
# Temporary file name used when downloading the OpenRA macOS launcher files.
|
|
PACKAGING_OSX_MONO_TEMP_ARCHIVE_NAME="mono.zip"
|
|
|
|
# The url to download the OpenRA AppImage dependencies.
|
|
PACKAGING_APPIMAGE_DEPENDENCIES_SOURCE="https://github.com/OpenRA/AppImageSupport/releases/download/${PACKAGING_APPIMAGE_DEPENDENCIES_TAG}/mono.tar.bz2"
|
|
|
|
# Temporary file name used when downloading the OpenRA AppImage dependencies.
|
|
PACKAGING_APPIMAGE_DEPENDENCIES_TEMP_ARCHIVE_NAME="mono.tar.bz2"
|
|
|
|
# List of .NET assemblies that we can guarantee exist
|
|
WHITELISTED_OPENRA_ASSEMBLIES="OpenRA.exe OpenRA.Utility.exe OpenRA.Server.exe OpenRA.Platforms.Default.dll OpenRA.Game.dll OpenRA.Mods.Common.dll OpenRA.Mods.Cnc.dll OpenRA.Mods.D2k.dll"
|
|
|
|
# These are explicitly shipped alongside our core files by the packaging script
|
|
WHITELISTED_THIRDPARTY_ASSEMBLIES="ICSharpCode.SharpZipLib.dll FuzzyLogicLibrary.dll Eluant.dll BeaconLib.dll Open.Nat.dll SDL2-CS.dll OpenAL-CS.Core.dll DiscordRPC.dll Newtonsoft.Json.dll"
|
|
|
|
# These are shipped in our custom minimal mono runtime and also available in the full system-installed .NET/mono stack
|
|
# This list *must* be kept in sync with the files packaged by the AppImageSupport and OpenRALauncherOSX repositories
|
|
WHITELISTED_CORE_ASSEMBLIES="mscorlib.dll System.dll System.Configuration.dll System.Core.dll System.Numerics.dll System.Security.dll System.Xml.dll Mono.Security.dll netstandard.dll"
|