Yadciel/AMPTemplates
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
For the AMP community to share Generic Module templates.
14 Commits 1 Branch 0 Tags 3.5 MiB
Shell 69.1%
PowerShell 30.9%
1bbfea0f06
Go to file
PhonicUK 1bbfea0f06
Update README.md
2021-09-16 13:08:38 +01:00
geyser.kvp Rename geysermc.kvp to geyser.kvp 2021-02-13 16:39:08 +01:00
geyserconfig.json Create geyserconfig.json 2021-02-13 16:37:20 +01:00
README.md Update README.md 2021-09-16 13:08:38 +01:00
valheim.kvp Update Valheim.kvp 2021-03-09 11:03:07 +00:00
valheimconfig.json Added field for modifying permitted list 2021-07-03 01:16:04 +02:00
valheimplus.kvp Update V+ config 2021-03-01 17:02:13 +00: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

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).
  • Only applications that run on both Windows and Linux are permitted.
  • No extra files/depencendencies. The application must be in a usable state purely using the built in update methods.
  • 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.