README.md

ampapi-spec

A program that automagically updates a JSON file and a human readable file with the AMP API methods.

Usage

For the JSON response of API.Core.GetAPISpec:

https://raw.githubusercontent.com/p0t4t0sandwich/ampapi-spec/main/APISpec.json

For the human readable response of API.Core.GetAPISpec (easier to check for differences):

https://github.com/p0t4t0sandwich/ampapi-spec/blob/main/FriendlySpec.txt

API module inheritance for different instance types:

https://github.com/p0t4t0sandwich/ampapi-spec/blob/main/ModuleInheritance.json

API docs

Go to http(s)://your.domain.com/API to see the API docs.

Libraries

C#

• Developer Licence Usage
• Examples:
  • SampleAMPModule - official code example
  • AMP-Discord-Bot - a great community developed Discord bot

NodeJS

• ampapi-node - bare bones, but generates new methods on the fly, not requiring library updates
• ampapi-js - auto-generated from the API, includes d.ts type definitions and code-completion
  • Examples:
    • taterland-discord-bot

Python

• AMPAPI_Python - built with developer experiences in mind, with all the bells and whistles you'll need
  • Examples:
    • GatekeeperV2
• ampapi-py - auto-generated from the API, though a bit bland in terms of tooling

Java

• ampapi-java
  • Examples:
    • ServerPanelManager
    • taterlib-ci
    • CustomServerManager

Go/Golang

• ampapi-go
  • Examples:
    • ampapi-stats-wrapper

Rust

• ampapi-rs

Work in Progress

• C++
• Bash
• PHP

Proxying-instance-auth explanation: AMP Discord #development