README.md

ProxyFeatures

One modular feature framework for your entire Velocity network.

Quick Start

1. Place ProxyFeatures.jar in your Velocity plugins/ directory.
2. Install dependencies: dataregistry and dataprovider.
3. Start the proxy once to generate defaults.
4. Enable the features you want in config.yml.
5. Restart and go live.

Requirements

• Java 21
• Velocity 3.5.0
• [Recommended] DataRegistry plugin
• [Recommended] DataProvider plugin

Build From Source

Add GitHub Packages credentials for Maven server id github in ~/.m2/settings.xml:

<settings>
  <servers>
    <server>
      <id>github</id>
      <username>YOUR_GITHUB_USERNAME</username>
      <password>YOUR_TOKEN</password>
    </server>
  </servers>
</settings>

Use a token with read:packages (and repo if the package source repositories are private), then run:

mvn -B package

Output jar: target/ProxyFeatures.jar

Learn More

• Configuration Guide
• Documentation Index
• Architecture
• Development Notes
• Testing and Quality
• Contributing

Community

• Support
• Security Policy
• Code of Conduct