/paper-deprecations

Overview over deprecated Elements in the Paper API

Primary LanguagetemplMIT LicenseMIT

JavaDoc Parser

A tool to generate reports on deprecated elements in the PaperMC API across different Minecraft versions.

GitHub Actions Workflow Status

Description

This tool parses the PaperMC JavaDocs to create a comprehensive report of all deprecated elements, organized by Minecraft version. It helps plugin developers track API changes and plan updates accordingly.

Features

  • Lists all deprecated classes, methods, and fields
  • Groups deprecations by Minecraft version
  • Links directly to JavaDoc sources
  • Caches results to avoid unnecessary fetches
  • Generates static HTML report

Building & Development

Prerequisites

  • Go 1.23 or higher
  • templ for HTML templating

Setup Development Environment

  1. Clone the repository
git clone https://github.com/thelooter/JavaDocParser.git
cd JavaDocParser
  1. Install dependencies
go mod download
  1. Install templ (required for HTML generation)
go install github.com/a-h/templ/cmd/templ@latest
  1. Generate template code
templ generate
  1. Build the project
go build -o JavaDocParser -v ./...

Available flags:

  • -c, --cache: Use cached data instead of fetching new data
  • -o, --output-dir: Directory to store generated files (default: ".")

Generated Files

  • deprecations.json: Cache file containing parsed deprecation data
  • deprecations.html: Generated HTML report

Limitations

  • Does not track methods already removed in previous versions
  • Some deprecated elements may not show version information if not specified in API docs

License

MIT License