DOCSEARCHbyAlgolia
Submit Docs

AMP Templates

repository·main·Indexed 41 days ago

https://github.com/cubecoders/amptemplates

A community repository for sharing Generic Module templates for the Application Management Panel (AMP). Includes guidelines for creating templates, submission requirements for pull requests, and details on the automated testing process for Windows and Linux configurations.

Tokens
653
Snippets
0
Records
4
Agent score
2%

What's inside AMP Templates

  1. Requirements for sharing AMP templates

    main

    Before submitting a template to the public repository, ensure it adheres to the following requirements:

    • No Authentication: The application must not require login/authentication to download (SteamCMD logins are an exception).
    • Linux Support: If the application lacks a native Linux version, you should add a Proton download via SteamCMD to support it if possible.
    • Settings Manifest: Applications with customizable settings must use a Settings Manifest.
    • Console Access: Only applications that expose a console that AMP can detect are eligible.
    • No Scripts: Do not invoke shell scripts or batch files. You must only launch actual executables.

  2. Understand the automated template testing process

    main

    Once a pull request is submitted, an automated tool tests the configuration in its current state. The tool performs the following lifecycle checks:

    1. Load: Attempts to load the configuration.
    2. Update: Attempts to perform an update.
    3. Start: Attempts to start the application.
    4. Ready State: Verifies the application reaches the 'Ready' state.
    5. Stop: Attempts to stop the application.
    6. Stopped State: Verifies the application reaches the 'Stopped' state.

    Requirement: You must ensure your configuration passes these steps on both Windows and Linux before submission.

  3. Submit an AMP template via Pull Request

    main

    To share a template, create a pull request containing exactly three files (or two if metaconfig is not needed) in the top-level directory. All filenames must be fully lower-cased.

    Required Files:

    1. *applicationame*.kvp
    2. *applicationame*config.json
    3. *applicationame*metaconfig.json (Optional)

    Example for 'Valheim':

    • valheim.kvp
    • valheimconfig.json
    • valheimmetaconfig.json

    Submission Rules:

    • Do not use directories.
    • Include no other files.
    • If you are submitting a draft, append (draft) to your pull request title.

  4. Create generic AMP module templates

    main

    To create templates for the Generic AMP module, you can refer to the official AMP wiki or use online configuration tools to assist in building them.

    Tools:

    Important Restrictions:

    • Templates produced by generators can be used personally, but they will not be accepted into the official CubeCoders repository.
    • AI-generated configurations will not be accepted.