Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 4.19 KB

README.md

File metadata and controls

106 lines (69 loc) · 4.19 KB
page_type author description ms.author ms.date languages products
sample
mammerla
A progressive example starting from a basic add-on with nothing in it (useful as a starter) - through an add-on with some mobs and into advanced logic.
11/15/2023
typescript
minecraft

Minecraft Add-on Start project

This sample demonstrates everything you need to have an add-on in Minecraft. There are three versions and progressions:

  • start is a foundational starter project. It comes with a justjs-based workflow tool
  • 1_hello_world is a basic entity that will show you that your add-on is working. It comes a mob that overrides the default cow in Minecraft
  • 2_entities adds a set of entities (from the MCLive2022 add-on pack to the add-on)
  • complete adds more functionality and scripts to the add-on

Prerequisites

Install Node.js tools, if you haven't already

We're going to use the Node Package Manager (or NPM) to get more tools to make the process of building our project easier.

Visit https://nodejs.org/.

Download the version with "LTS" next to the number and install it.

Install Visual Studio Code, if you haven't already

Visit the Visual Studio Code website and install Visual Studio Code.

Getting Started

  1. Using a copy of this starter project from GitHub - you can get a copy of this project by visiting https://github.com/microsoft/minecraft-samples/ and, under the Code button, selecting Download ZIP.

  2. The addon_starter/start folder contains a starter add-on project for Minecraft.

  3. To make your own environment look like the example, create a folder on your C:\ drive and call it projects. Create a subfolder called myaddon.

  4. Put the extracted contents of the Add-on Starter Project folder into myaddon.

  5. Open a Windows Terminal or PowerShell window and change the working directory to your myaddon folder:

    cd c:\projects\myaddon\

  6. Use NPM to install our tools:

    npm i

  7. Use this shortcut command to open the project in Visual Studio Code:

    code .

It might also ask you to install the Minecraft Debugger and Blockception's Visual Studio Code plugin, which are plugins to Visual Studio Code that can help with Minecraft development. Go ahead and do that, if you haven't already.

  1. In Visual Studio Code, open the file .env. This contains the environment variables to use to configure project:
PROJECT_NAME="starter"
MINECRAFT_PRODUCT="BedrockUWP"
CUSTOM_DEPLOYMENT_PATH=""

  • PROJECT_NAME is used as the folder name under all the assets are going to be deployed inside the game directories (e.g., development_behavior_packs\PROJECT_NAME, development_resource_packs\PROJECT_NAME).

  • MINECRAFT_PRODUCT. You can choose to use either Minecraft or Minecraft Preview to debug and work with your scripts. These are the possible values: BedrockUWP, PreviewUWP, Custom. Use Custom in case of deploy on any other path.

  • CUSTOM_DEPLOYMENT_PATH. In case of using Custom for MINECRAFT_PRODUCT, this is the path used to generate the assets.

Running the project

To get started, go into PowerShell and navigate to your C:\projects\myaddon directory.

Run this command:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

Run this one, too.

npm run local-deploy

Summary

With this starter, you've seen how to build a nice little add-on.

Manifest

-start: This contains a starter add-on bare-minimum set of files. -1_hello_world: This contains a starter add-on with a basic starter entity. -2_entities: This contains a starter add-on with a full set of entities. -complete: This contains the finished add-on starter example.