BlockIDE

BlockIDE is a Minecraft-focused IDE built on Code - OSS. It keeps the editing, navigation, debugging and extension model of VS Code and adds first-class Minecraft tooling: a Minecraft Java Edition launcher, a mod development workspace and a server manager, all bundled in.

The Repository

This repository holds the source of BlockIDE and is maintained by ZIT Studio. It is a fork of the Code - OSS repository and is available under the standard MIT license. Upstream VS Code is developed by Microsoft and the community at microsoft/vscode.

What BlockIDE changes

• Product identity — the application is named BlockIDE (blockide), with its own data folder, URL protocol, application icons and About dialog.
• Built-in Minecraft Workbench — the Minecraft Workbench extension by Lopleec is bundled as a git submodule at extensions/minecraft-workbench, tracked from zitzhen/VSCode-minecraft-workbench, so it does not have to be installed from a VSIX. It activates on startup, which means the Minecraft view is already there when the IDE opens.
• Default Minecraft sign-in — a Microsoft public-client application ID is preconfigured for device code sign-in, so signing in with a Microsoft account works out of the box. Set minecraftWorkbench.microsoftClientId in Settings to switch to your own application ID.

Bundled Extensions

BlockIDE includes a set of built-in extensions located in the extensions folder, including grammars and snippets for many languages. Extensions that provide rich language support (inline suggestions, Go to Definition) for a language have the suffix language-features. For example, the json extension provides coloring for JSON and the json-language-features extension provides rich language support for JSON.

The minecraft-workbench extension is bundled as well, as a git submodule of zitzhen/VSCode-minecraft-workbench. Its original upstream project, release history and issue tracker remain at lopleec/VSCode-minecraft-workbench.

Development

Clone with submodules, or initialize them in an existing checkout — the build fails without the extension sources:

git clone --recurse-submodules https://github.com/zitzhen/BlockIDE.git
# or, in an existing checkout
git submodule update --init

The build setup is inherited from Code - OSS, so the upstream documentation still applies:

• How to build and run from source
• The development workflow, including debugging and running tests
• Coding guidelines
• Submitting pull requests

Changes to the bundled extension are built with extensions/minecraft-workbench/.esbuild.mts, the entry point the repository build system uses:

cd extensions/minecraft-workbench
npm ci
npm run compile

Feedback

• File an issue
• Review source code changes

Related Projects

Many of the core components and extensions to VS Code live in their own repositories on GitHub. For example, the node debug adapter and the mono debug adapter repositories are separate from each other. For a complete list, please visit the Related Projects page on the upstream wiki.

Development Container

This repository includes a Code - OSS Dev Containers / GitHub Codespaces development container.

• For Dev Containers, use the Dev Containers: Clone Repository in Container Volume... command, which creates a Docker volume for better disk I/O on macOS and Windows.

• For Codespaces, install the GitHub Codespaces extension and use the Codespaces: Create New Codespace command.

Docker / the Codespace should have at least 4 cores and 6 GB of RAM (8 GB recommended) to run a full build. See the development container README for more information.

License

Copyright (c) Microsoft Corporation. All rights reserved. Modifications and additions for BlockIDE: Copyright (c) ZIT Studio.

Licensed under the MIT license.