├── LICENSE ├── README.md └── _images ├── change-default-app.png ├── create-new-shortcut.png ├── editor-header-image.png ├── editor_install_shortcut_path_preview.png ├── install-bedrock-preview.png ├── install-the-launcher.png ├── open-the-editor.gif ├── specify-destination.png └── what-should-you-see.png /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Mojang 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Welcome to the Minecraft: Bedrock Editor! 2 | 3 | Stylized image of the Minecraft Bedrock Editor 4 | 5 | Minecraft Editor is an in-engine, multiblock editing experience focused on making it possible for creators of all skillsets to easily craft high-quality experiences in Bedrock. 6 | 7 | It is a framework that is designed to allow creators to use more complex tools to build, edit, and test worlds than simple gameplay allows. It leverages the game's built-in JavaScript Scripting API in conjunction with a number of native tools built directly into the game itself, to expose a rich environment in which creators can build tools which empower and enhance their editing experience, in the form of "Editor Extensions." 8 | 9 | --- 10 | 11 | ## Housekeeping 12 | - The Editor is in early development and we're working to add more capabilities. It will change as we get feedback from creators like you. 13 | - Editor will be exclusively available in Bedrock Preview on Windows, keyboard/mouse until the feature set and quality meets our standards. 14 | - Editor is not a new gamemode. It is a tool to assist creators in their worldbuilding workflows. 15 | 16 | --- 17 | 18 | ## Development 19 | We are in early development and there is still a lot of work our team has ahead of us. In line with our principles, we want to share early and often with you. We are eager for your feedback and want to work with you to iterate. 20 | 21 | --- 22 | 23 | ## Extensibility 24 | We are building an Editor API. While we have iterations to the core Editor experience we want to make, we are also focused on unlocking functionality via the API for you to build your own editing tools -- which we are calling "Extensions." 25 | 26 | v0.4: The Editor API Update was the initial release of the Editor API. Below are supplemental resources to the content in this repo: 27 | 28 | | **Resources** | **Description**| 29 | | -- | -- | 30 | | [Script API Docs](https://docs.microsoft.com/minecraft/creator/scriptapi/) | Official Microsoft docs for the Creator Scripting API. | 31 | | [Editor API Docs](https://aka.ms/EditorAPI) | Official Microsoft docs for the Editor API. | 32 | | [Editor Extension Starter Kit](https://github.com/Mojang/minecraft-editor-extension-starter-kit) | A repo containing the build pipeline, libraries, and types required for you to build a Minecraft Editor Extension. | 33 | | [Editor Extension Samples](https://github.com/Mojang/minecraft-editor-extension-samples) | Extension examples for you to use as a foundation for your own creations, or to learn from. | 34 | 35 | _Note:_ If you are exploring scripting _outside_ of the Editor experience, make sure to enable the "Beta APIs" toggle in Experiments when creating a new world. We also encourage you to proactively brush up on Javascript and Typescript, as that will be the language used for Editor extensions. 36 | 37 | --- 38 | 39 | ## Accessing the Editor 40 | Bedrock Editor is for Windows PC, keyboard + mouse only. View the [documentation](https://aka.ms/LearnEditor) to learn more about the Editor. 41 | 42 | **Three-step quick start for getting the Editor:** 43 | 44 | 1. Install Bedrock Preview via the [Launcher](https://help.minecraft.net/hc/en-us/articles/4412261881229-Minecraft-Launcher-for-Windows-). 45 | 46 | | Install the Launcher | Install Bedrock Preview | 47 | |--|--| 48 | | Image of installing the Launcher from the Microsoft Store | Image of installing Minecraft Bedrock Preview from the Minecraft Launcher | 49 | 50 | 2. Create a desktop shortcut. When prompted for the filename, copy/paste the following into the textfield: `minecraft-preview:?Editor=true` 51 | 52 | | Create a new shortcut | Specify the destination | 53 | |--|--| 54 | | Image of right clicking on Windows desktop to create a new shortcut | Image of pasting the shortcut minecraft:?Editor=true as the destination for the shortcut | 55 | 56 | 57 | 3. Open the Editor via the desktop shortcut you created. 58 | Animation of opening the Editor via the desktop shortcut you created 59 | 60 | _If your desktop shortcut doesn't appear to be launching the Editor, you may need to change the default app from `Minecraft` to `Minecraft Preview`. View the Troubleshooting section at the end of this README._ 61 | 62 | --- 63 | 64 | ## Resources 65 | 66 | | **Resource** | **Description** | 67 | |--|--| 68 | | [Documentation](https://aka.ms/LearnEditor) | Learn how to use the Editor | 69 | | [Minecraft: Bedrock Edition Preview Changelogs](https://feedback.minecraft.net/hc/en-us/sections/360001185332-Beta-and-Preview-Information-and-Changelogs) | View the Preview changelogs | 70 | | [/mojang/minecraft-editor](https://github.com/Mojang/minecraft-editor) | Participate in [discussions and provide feedback to our team](https://github.com/Mojang/minecraft-editor/discussions) | 71 | | [Editor API Docs](https://aka.ms/EditorAPI) | Official Microsoft docs for the Editor API. | 72 | | [Editor Extension Starter Kit](https://github.com/Mojang/minecraft-editor-extension-starter-kit) | A repo containing the build pipeline, libraries, and types required for a 3rd party to build a Minecraft Editor Extension. | 73 | | [Editor Extension Samples](https://github.com/Mojang/minecraft-editor-extension-samples) | Extension examples for you to use as a foundation for your own creations, or to learn from. | 74 | 75 | --- 76 | 77 | ## Troubleshooting 78 | 79 | If your desktop shortcut doesn't appear to be launching the Editor, you may need to change the default app from `Minecraft` to `Minecraft Preview`. Follow the directions below: 80 | 1. Press `Windows + I` to open the Settings app 81 | 2. Select `Apps` and click `Default apps` 82 | 3. Search for `Minecraft` and select it 83 | 4. Scroll down and find the `MINECRAFT` entry (it should also say `Minecraft | URL:minecraft`) and click it 84 | 5. In the pop-up, select `Minecraft Preview` and click ok 85 | 86 | | Change default app | What you should see when the Editor launches | 87 | |--|--| 88 | | Image that shows how to change your default app | Image that shows what you should see when the Editor launches, which is the create new project screen | 89 | -------------------------------------------------------------------------------- /_images/change-default-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/change-default-app.png -------------------------------------------------------------------------------- /_images/create-new-shortcut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/create-new-shortcut.png -------------------------------------------------------------------------------- /_images/editor-header-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/editor-header-image.png -------------------------------------------------------------------------------- /_images/editor_install_shortcut_path_preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/editor_install_shortcut_path_preview.png -------------------------------------------------------------------------------- /_images/install-bedrock-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/install-bedrock-preview.png -------------------------------------------------------------------------------- /_images/install-the-launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/install-the-launcher.png -------------------------------------------------------------------------------- /_images/open-the-editor.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/open-the-editor.gif -------------------------------------------------------------------------------- /_images/specify-destination.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/specify-destination.png -------------------------------------------------------------------------------- /_images/what-should-you-see.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mojang/minecraft-editor/da6016febddf9980d3518c9cbf6dbb43b0d71ed1/_images/what-should-you-see.png --------------------------------------------------------------------------------