Skip to content

PrismarineJS/llm-guides

Repository files navigation

LLM Guides for PrismarineJS

This repository contains comprehensive guides for using Large Language Models (LLMs) to assist with Minecraft protocol analysis and minecraft-data maintenance.

πŸ“š Available Guides

Protocol Analysis

minecraft-data Maintenance

  • How to Update proto.yml - Step-by-step guide for updating proto.yml files when new Minecraft versions are released

Protocol Documentation

🎯 Purpose

These guides are designed to:

  • Accelerate protocol analysis with LLM assistance
  • Ensure consistency in minecraft-data updates
  • Preserve knowledge about protocol change patterns
  • Enable community contributions with clear documentation
  • Maintain quality through systematic approaches

πŸš€ Quick Start

  1. For Protocol Analysis: Start with minecraft-protocol-analysis.md
  2. For proto.yml Updates: Follow minecraft-data-proto-yml-updates.md
  3. For Documentation: See examples in protocol-changes-examples/

πŸ”§ Key Principles

  • Packet ordering is critical - Protocol IDs are determined by registration order, not alphabetical
  • Java diff analysis is essential - Always find exact insertion points in protocol registration
  • Systematic verification - Use consistent workflows to prevent errors
  • Documentation first - Analyze and document before implementing

πŸ“– Contributing

To add new guides or improve existing ones:

  1. Follow the established documentation format
  2. Include practical examples and code snippets
  3. Emphasize critical steps and common pitfalls
  4. Test guides with real protocol changes

πŸ—οΈ Related Projects

πŸ“„ License

MIT License - See individual files for specific licensing information.

About

LLM guides for Minecraft protocol analysis and minecraft-data maintenance

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •