documentation

Documentation

Welcome to the Minecraft Bedrock Language Server documentation! This folder contains guides, references, and tutorials for using and contributing to the project.

Table of Contents

Core Documentation

• Architecture - Package dependency graph, LSP server composition, data flow, and contribution how-tos
• Commands - Available commands in the extension
• Debugging - How to debug the language server
• JSON Validation - JSON schema validation guide
• Style Guide - Code style and conventions
• Release Process - How to release new versions
• Releasing - Release procedures and guidelines

Feature Guides

Completion

Documentation for autocomplete and IntelliSense features.

• Mcfunctions - Completion for mcfunction files

Guides

Step-by-step guides for implementing features.

• Setting Up a Bedrock Project - How to start a new Minecraft Bedrock Edition project from scratch
• Contributing Features - Workflow-centric guide for contributors: adding diagnostics, completions, or definitions, submitting PRs, and getting help
• JSON Completion - How to add JSON completion support
• Creating Diagnostics - How to add diagnostic error codes
• Project Templates and Recommended Practices - How to find, use, adapt, and maintain project templates
• Molang Language Support - Guide to Molang scripting assistance, completions, diagnostics, and debugging
• Working with Ignore Files - Using .mcignore to control which files are validated

Project Configuration

Documentation for project-level configuration files.

• MCAttributes - Project attributes and settings
• MCDefinitions - Define custom tags, objectives, and entities
• MCIgnore - Exclude files and folders from the project

Templates

Documentation for file templates and variable substitution.

• Templates - Creating and using templates
• Variables - Available template variables

Resources

The resources folder contains images and other assets used in the documentation.

Getting Help

• Check the main README for general project information
• Review the Contributing Guide for contribution guidelines
• Open an issue on GitHub for questions or bug reports

Contributing to Documentation

We welcome improvements to our documentation! When contributing:

1. Follow the Style Guide
2. Keep documentation clear and concise
3. Include examples where helpful
4. Update the table of contents when adding new files
5. Test all links to ensure they work correctly