Skip to content

README.md

Latest commit

 

History

History
75 lines (62 loc) · 3 KB

README.md

File metadata and controls

75 lines (62 loc) · 3 KB

AutoGG Server Configurations

Welcome to the Ember Client AutoGG repository! Here, we manage server-specific configurations for AutoGG, defining trigger messages, commands, and validation rules for each Minecraft server.

Repository Structure

  • servers/: Holds individual server configurations, with each server having its own JSON file (e.g., hypixel.json, mineplex.json).
  • schema.json: Defines the structure and requirements for each configuration file.
  • scripts/: Python scripts for validation and merging.
    • validate.py: Checks each server configuration against the schema.
    • merge.py: Combines all configurations into a single JSON file.

Contributing & Adding a New Server

Want to add a new server or update existing configurations? Follow these steps:

  1. Fork this repository and create a new branch for your changes.
  2. Add a new JSON file in the servers directory, or modify an existing one.
    • Name it servername.json (for example, hypixel.json).
    • List only the main domain in the hosts array — no need to include subdomains.
    • Use this template as a guide:
    {
  "hosts": ["hypixel.net"],
  "triggers": [
    {
      "pattern": "Winner: ",
      "matchType": "prefix",
      "caseSensitive": true
    },
    {
      "pattern": "Game Over!",
      "matchType": "exact"
    }
  ],
  "command": "/ac {message}",
  "validation": {
    "startsWith": " ",
    "excludePatterns": []
  }
}

Configuration Fields

  • hosts: Array of domain names this configuration applies to
  • triggers: Array of trigger objects with the following properties:
    • pattern: The text to match against
    • matchType: How to match the pattern (defaults to "prefix")
      • "exact": Match the entire message
      • "prefix": Match at the start of the message
      • "contains": Match anywhere in the message
      • "suffix": Match at the end of the message
    • caseSensitive: Whether the match should be case-sensitive (defaults to true)
  • command: Command to execute when triggered (must include {message} placeholder)
  • validation (optional): Rules for validating the trigger message
    • startsWith: Required prefix for the message
    • endsWith: Required suffix for the message
    • excludePatterns: Array of patterns that should not appear in the message

Deployment

Once changes are merged into the main branch:

  1. All configurations go through final validation.
  2. Valid files are merged into a single JSON file.
  3. The file is uploaded to our CDN.
  4. The latest configuration is available at https://cdn.emberclient.com/autogg/servers.json.

Notes

  • All triggers must be defined as objects with a pattern and optional matchType/caseSensitive properties
  • The matchType defaults to "prefix" if not specified
  • The caseSensitive property defaults to true if not specified
  • The command must include a {message} placeholder which will be replaced with the actual message at runtime