GETTING-STARTED.md

Getting Started

Requirements

• Java 21 or higher

Building

./gradlew build

The built JAR will be in build/libs/.

Quick Start

1. Install the mod on your Minecraft server
2. Start the game and join a world
3. Run /ptracker start to begin tracking
4. Run /ptracker stop to stop tracking and view results

Basic Commands

/ptracker start          # Start tracking performance
/ptracker stop           # Stop tracking and view results
/ptracker deviceinfo     # Display your device information
/ptracker config         # List all configuration options

For detailed command usage, see Commands.

Next Steps

• Configure which metrics to collect in Configuration
• Set up network features in Network API
• Review Privacy considerations