This folder contains step-by-step guides for implementing features and extending the Minecraft Bedrock Language Server.
These guides are designed for both end users and developers:
- End users (creators, map makers, add-on developers) — Learn how to use and configure the extension's features to boost your workflow.
- Developers — Learn how to add new features, understand the codebase architecture, and contribute to the project.
- Setting Up a Bedrock Project - Step-by-step guide for new users starting a Minecraft Bedrock Edition project from scratch
- Command Autocompletion - User guide for using and extending command autocomplete features (MCfunction, JSON, MoLang, custom commands)
- Contributing Features - Workflow-centric guide for contributors: how to add diagnostics, completions, or definitions, submit a PR, and get help
- JSON Completion - Comprehensive guide for adding JSON completion (autocomplete) support to new file types
- Creating Diagnostics - Guide for adding new diagnostic error codes to the language server
- Project Templates and Recommended Practices - How to find, use, adapt, and maintain project templates for rapid onboarding
- Working with Ignore Files - User guide for
.mcignore: syntax, practical scenarios, common mistakes, and best practices
Each guide typically includes:
- Overview - What the feature does and when to use it
- Architecture - How the feature is structured in the codebase
- Step-by-Step Implementation - Detailed instructions for implementing the feature
- Examples - Code examples from the existing codebase
- Best Practices - Tips for writing maintainable code
- Testing - How to test your implementation
- Common Issues - Troubleshooting tips
Before following any guide, make sure you:
- Have cloned the repository and installed dependencies
- Can build the project successfully (
npm run build) - Are familiar with TypeScript and the Language Server Protocol
- Have read the Contributing Guide and Style Guide
- Completion - Documentation for completion features
- Project Configuration - Project-level configuration
- Style Guide - Code style and conventions
- Debugging - How to debug the language server
If you'd like to add a new guide:
- Create a new markdown file in this folder
- Follow the structure of existing guides
- Include clear examples and explanations
- Update this README to link to your new guide
- Test all code examples and links
For questions or suggestions, please open an issue on GitHub.