Giter VIP home page Giter VIP logo

amptemplates's Introduction

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).
  • If the application does not have a Linux version you should add a Proton download via SteamCMD to support it if possible.
  • 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.

If you are only submitting a draft, make sure to append (draft) to the pull request title.

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.

amptemplates's People

Contributors

abigailwillow avatar ashdevfr avatar bjorno43 avatar databitz avatar dragoon209 avatar ekicilp avatar gkuba avatar goover avatar greelan avatar iceofwraith avatar jasperfirecai2 avatar k8thekat avatar maggi373 avatar mrhanman avatar phonicuk avatar shinynecrid avatar southnode avatar tempusthales avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.