AMP Configuration Generator

Basic Information

What is the name of the application?

This is what will show up within AMP as the name of the application.

Description

Optional: useful for describing different variants/configurations of the same application.

Configuration Author

Who are you? Take some credit for your work!

Application URL

A link to where you can learn more about the application, such as a store listing.

Which operating systems are supported?

Windows Runs on Windows 10/Server 2016 or newer. x86/64 Only. Linux Runs on Linux Systems. Recommend validating on Debian 10 x86/64.

Management and Console

How is this application managed?

None For applications that cannot be managed. AMP will only be able to provide basic monitoring. Standard IO For applications with a normal console that can be read from and/or written to. Source RCON For applications that use the standard Source RCON Protocol. Telnet BattleEye WebRCON Quake RCON AMP GS/IO For applications that use CubeCoders GameServer/IO Standard.

What modes are supported by the applications console?

This is in addition to the applications management type if it accepts management over methods other than Standard IO

Reading This application writes log output to its console that AMP can read. Writing The console of this application supports having input written to it.

Networking

AMP will automatically generate firewall rules to allow the application ports through

Port Number	Usage Type

No ports have been added.
You may add up to 3 ports. The RCON port does not count towards this limit. Maximum of 1 Steam Query and 1 RCON Port.

Update Sources

How is this application downloaded and updated?

Not Applicable For applications that do not need to be (or cannot be) automatically downloaded or updated. Fetch from URL Fetches a file from an URL and saves it to disk Steam Download Download an application from Steam via SteamCMD GitHub Release Downloads the latest release for a GitHub repository Multiple Update Stages/Sources (Coming Soon!) This application requires a combination of the above steps to download or update, or uses different sources for different platforms.

Update source URL

This must be a direct URL that is not behind any access gates.

Unzip once downloaded The downloaded file is a .zip that needs to be decompressed. Does not support other archive types (such as .tar.gz) at this time.

Server Steam App ID

The App ID for the dedicated server application. You can find this via SteamDB.

Client Steam App ID

The App ID for the game itself. You can find this via SteamDB.

Update source URL

Must be a publicly accessible GitHub repository.

Display image source URL

PNG or JPEG format, 460x215px.

Configuration and Settings

Display Name	Description	Field Name	Default Value	Command Line

No settings have been added.

Startup and Shutdown

Application and Parameters

Windows Executable

Linux Executable

Command line arguments

Don't include any arguments that come from the Configuration and Settings section above.

Command line paramter format

The format to be used to add settings specified above to the command line in place of {{$FormattedArgs}}. {0} is the field name and {1} the value.

Command line parameter delimiter

The character(s) used to separate different arguments in the command line flags generated by settings. By default this is a single space.

Startup Mode

Standard For applications that take some time to start. AMP will display a notification until startup has been confirmed. Rapid For applications that can start very quickly (Under 5 seconds) - AMP will not create a notification/task for startup.

Startup Confirmation Mode

Immediate AMP will assume that the application is ready immediately without making any checks. Successful RCON Connection Once AMP connects to the game servers RCON successfully, it will treat the server as being ready. Wait for message (Regular Expression) AMP will wait until the server produces a message matching a regular expression before assuming it's ready.

Shutdown

Shutdown Method

Command to send

Server Events

These are regular expressions that when matched notifies AMP about in-application events such as a successful startup, or users connecting/disconnecting. AMP will match these based on output from either the servers standard output (if enabled) or whichever RCON/remote access protocol is in use.

All expressions must match the entire subject string - so they must always start with a ^ and end with a $. AMP uses named capture groups to pick out different components of an expression.

Regex101 is an excellent resource to help you put together and validate expressions. AMP uses the 'Javascript' regex flavour.

Junk/throwaway message expression Messages matching this expression will be disposed of and ignored, they will not show up in any of AMPs logs.

Server ready expression When matched, AMP will transition from the 'starting' to the 'ready' state.

User connected expression Must have either a `username` or `userid` capture group and optionally an `endpoint` group.

User disconnected expression Must have either a `username` or `userid` capture group

User chat expression Must have either a `username` or `userid` capture group plus a `message` capture group.

Validate and Review

Generated Command Line Arguments

This is generated assuming the default values and default port numbers, these will change based on user-specified values or assignments made by AMP.

You have not yet validated your configuration. You will not be able to download your configuration until you have done this.

Validation Failed - You must address the following failures before you may continue.

Validation Passed with Warnings - You should consider addressing the following warnings.

Validation Passed - Great stuff! You may now download the completed configuration below.

Validation Issues:

Category	Issue	Recommentation

Impact:
No validation issues

Make sure to keep a backup of your configuration by using the 'Export' option at the top of the page! You will need this to make further changes even after downloading the configuration and manifest.

Using the generated configuration

Place the .kvp and .json files in your ADS instance under the /Plugins/ADSModule/GenericTemplates directory along side the other .kvp and .json files.

Then restart ADS, and your new configuration will appear as an option when you select 'Create Instance'.