Yadciel/AMPTemplates
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
For the AMP community to share Generic Module templates.
114 Commits 1 Branch 0 Tags 3.5 MiB
Shell 69.1%
PowerShell 30.9%
aec21f7093
Go to file
Greelan aec21f7093 Add ability for user to add custom Java and server arguments 
Revert "Add IP binding parameter"

This reverts commit 9211cd66ef.

Add ability for user to add custom args

Add ability for user to add custom arguments

Update to all both java and server arguments
2022-01-02 13:53:54 +11:00
.github/ISSUE_TEMPLATE Update ConfigRequest.md 2021-10-07 23:15:23 +01:00
astroneer.kvp Add files via upload 2021-11-06 14:57:13 +01:00
astroneerconfig.json Added more config fields 2021-12-16 17:41:46 +01:00
astroneermetaconfig.json Added more config fields 2021-12-16 17:41:46 +01:00
avorion.kvp Add files via upload 2021-10-07 09:23:43 -05:00
avorionconfig.json Add files via upload 2021-10-07 09:23:43 -05:00
brokeprotocol.kvp Rename brokeprotokol.kvp to brokeprotocol.kvp 2021-12-21 11:29:21 +00:00
brokeprotocolconfig.json Rename brokeprotokolconfig.json to brokeprotocolconfig.json 2021-12-21 11:29:37 +00:00
brokeprotocolmetaconfig.json Rename bpmetaconfig.json to brokeprotocolmetaconfig.json 2021-11-11 11:56:32 +00:00
geyser.kvp Update geyser.kvp 2021-12-01 18:07:40 +00:00
geyserconfig.json Create geyserconfig.json 2021-02-13 16:37:20 +01:00
kaboom.kvp Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
kaboomconfig.json Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
last-oasis.kvp Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
last-oasisconfig.json Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
project-zomboid.kvp Add ability for user to add custom Java and server arguments 2022-01-02 13:53:54 +11:00
project-zomboidconfig.json Add ability for user to add custom Java and server arguments 2022-01-02 13:53:54 +11:00
README.md Update README.md 2021-10-07 13:55:54 +01:00
risk-of-rain-2.kvp Add Risk of Rain 2 2021-12-22 18:09:48 -06:00
risk-of-rain-2config.json Add Risk of Rain 2 2021-12-22 18:09:48 -06:00
risk-of-rain-2metaconfig.json Add Risk of Rain 2 2021-12-22 18:09:48 -06:00
satisfactory.kvp Update satisfactory.kvp 2021-10-27 00:28:48 +01:00
squad-dedicated-server.kvp Add files via upload 2021-10-14 08:56:41 -05:00
squad-dedicated-serverconfig.json Add files via upload 2021-10-14 08:56:41 -05:00
starmade.kvp Add StarMade Module 2021-12-29 13:50:59 -06:00
starmadeconfig.json Add StarMade Module 2021-12-29 13:50:59 -06:00
sven-co-op.kvp Adding Sven Co-op 2021-12-22 00:28:23 -06:00
sven-co-opconfig.json Adding Sven Co-op 2021-12-22 00:28:23 -06:00
sven-co-opmetaconfig.json Adding Sven Co-op 2021-12-22 00:28:23 -06:00
valheim.kvp Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
valheimconfig.json Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00
valheimplus.kvp Added Last Oasis and Kaboom, updated Valheim. 2021-10-14 14:53:11 +01:00

README.md

AMP Templates

For the AMP community to share Generic Module templates.

Making generic module templates

See the wiki article for the module: https://github.com/CubeCoders/AMP/wiki/Configuring-the-'Generic'-AMP-module

You can also use the online configurator at https://config.getamp.sh/ to help with building templates.

Sharing Templates

Right now the following restrictions apply to templates that may be publicly shared via this repository (some of these will be relaxed over time):

  • The application must not require any login/authentication in order to download (except for SteamCMD logins).
  • Both Windows and Linux must be accomodated for. If the application does not have a Linux version you should add a Proton download via SteamCMD to support it.
  • Applications that have customizable settings must use a Settings Manifest.
  • Only applications that expose some kind of Console that AMP is able to pick up.
  • Do not invoke any shell scripts/batch files. You must only launch actual executables.

To share a template

Create a pull request containing the following files in the top-level directory of the repository:

*APPLICATIONAME*.kvp
*APPLICATIONAME*config.json
*APPLICATIONAME*metaconfig.json (Optional)

With the names fully lower-cased.

For example, valheim.kvp, valheimconfig.json, valheimmetaconfig.json

Do not use any directories and include no-other files.

Editing templates

If you believe that a template needs either updating or changes made, please submit a pull request for that template with a justification for why that change is needed. If possible try and contact the original author first.

After submitting a template

Once you've submitted a pull request, your configuration will be tested in its as-is state by an automated tool. It will:

  • Load the configuration
  • Attempt to perform an update
  • Attempt to start the application
  • Verify that the application reaches the 'Ready' state.
  • Attempt to stop the application
  • Verify that the application reaches the 'Stopped' state.

You should ensure that your configuration can do this on both Windows and Linux before submitting your configuration.