![banner](https://raw.githubusercontent.com/SPGoding/vscode-datapack-helper-plus/master/img/banner.png) [![Discord](https://img.shields.io/discord/666020457568403505?logo=discord&style=flat-square)](https://discord.gg/EbdseuS) [![GitHub Actions](https://img.shields.io/github/workflow/status/SPGoding/datapack-language-server/Test?logo=github&style=flat-square)](https://github.com/SPGoding/datapack-language-server/actions) [![npm](https://img.shields.io/npm/v/datapack-language-server.svg?logo=npm&style=flat-square)](https://npmjs.com/package/datapack-language-server) [![Codecov](https://img.shields.io/codecov/c/gh/SPGoding/datapack-language-server.svg?logo=codecov&style=flat-square)](https://codecov.io/gh/SPGoding/datapack-language-server) [![License](https://img.shields.io/github/license/SPGoding/datapack-language-server.svg?style=flat-square)](https://github.com/SPGoding/datapack-language-server/blob/master/LICENSE) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square)](https://gitmoji.carloscuesta.me/) Data-pack Language Server can provide many heavy language features for documents in your datapack, including advancements, dimensions, dimension types, functions, loot tables, predicates, recipes, all kinds of tags, and all kinds of worldgen files. - [Installation](#installation) - [For Use](#for-use) - [Sublime Text 3](#sublime-text-3) - [Visual Studio Code](#visual-studio-code) - [For Developers](#for-developers) - [Contributors](#contributors) - [Contributors for 3.1.0](#contributors-for-310) - [Contributors for older versions](#contributors-for-older-versions) - [Contributing](#contributing) # Installation ## For Use ### Sublime Text 3 1. Install [Node.js](https://nodejs.org/) if you haven't. 2. Execute `npm i -g @spgoding/datapack-language-server` in your command line to install the language server. 3. Install [Package Control](https://packagecontrol.io/installation) if you haven't. 4. Install [Arcensoth](https://github.com/Arcensoth)'s language-mcfunction package by following the [instructions](https://github.com/Arcensoth/language-mcfunction#installing-the-sublimetext-package) if you haven't. 5. Install [LSP](https://packagecontrol.io/packages/LSP) package. 6. Open the Command Palette and select `Preferences: LSP Settings`. 7. Configure LSP to add the Data-pack Language Server. Here's one example: ```json { "clients": { "datapack-language-server": { "command": [ "datapack-language-server", "--stdio" ], "enabled": true, "languages": [ { "languageId": "mcfunction", "scopes": [ "source.mcfunction" ], "syntaxes": [ "Packages/language-mcfunction/mcfunction.tmLanguage" ] }, { "languageId": "json", "scopes": [ "source.json" ], "syntaxes": [ "Packages/JavaScript/JSON.sublime-syntax" ] } ] } }, "only_show_lsp_completions": true } ``` 8. Open the Command Palette, select `LSP: Enable Language Server Globally`, and choose `datapack-language-server`. 9. Enjoy. Do note that you need to execute the command in step 2 manually if you want to update the language server. - TODO (for SPGoding): make a fine-tuned Sublime package, so that the language server can be updated automatically and the user doesn't need to set all these crazy stuff. ### Visual Studio Code We have a ready-for-use [VS Code](https://code.visualstudio.com/) extension: [![VSCode Marketplace](https://img.shields.io/visual-studio-marketplace/v/SPGoding.datapack-language-server.svg?logo=visual-studio-code&style=flat-square)](https://marketplace.visualstudio.com/items?itemName=SPGoding.datapack-language-server) ## For Developers See our [wiki](https://github.com/SPGoding/datapack-language-server/wiki/Language%20Server%20Details) for more information. Also please note that _only_ the `DatapackLanguageService` class and its methods are considered as public API. _All_ other exported classes/functions/variables, including but not limited to _everything_ under the `nodes` directory, are not part of the public API and are subject to change breakingly in even patch/minor versions. _Do not_ make your systems depend on them. # Contributors This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! ## Contributors for 3.1.0

Arcensoth		⬆️ Maintains mcdata repository
ChenCMD		💎 Collaborator

Devon7925		🐛 #703
Misode		⬆️ Maintains minecraft-schemas repository

MulverineX		🐛 #747
NeunEinser		✨ #736
🐛 #739
🐛 #748

Yurihaia		⬆️ Maintains mc-nbtdoc repository
barraIhsan		🐛 #769

chawdan		🐛 #765
zyjking		☕ Coffee
## Contributors for older versions - [1.x.x](./contributors/1.x.x.md) - [2.0.x](./contributors/2.0.x.md) - [2.1.x](./contributors/2.1.x.md) - [3.0.x](./contributors/3.0.x.md) ## Contributing If you'd like to contribute, check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.