You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: addon_starter/README.md
+16-19Lines changed: 16 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,10 +14,10 @@ products:
14
14
15
15
This sample demonstrates everything you need to have an add-on in Minecraft. There are three versions and progressions:
16
16
17
-
*`start` is a foundational starter project. It comes with a justjs-based workflow tool
18
-
*`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
19
-
*`2_entities` adds a set of entities (from the MCLive2022 add-on pack to the add-on)
20
-
*`complete` adds more functionality and scripts to the add-on
17
+
-`start` is a foundational starter project. It comes with a justjs-based workflow tool
18
+
-`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
19
+
-`2_entities` adds a set of entities (from the MCLive2022 add-on pack to the add-on)
20
+
-`complete` adds more functionality and scripts to the add-on
21
21
22
22
## Prerequisites
23
23
@@ -45,35 +45,35 @@ Visit the [Visual Studio Code website](https://code.visualstudio.com) and instal
45
45
46
46
1. Open a Windows Terminal or PowerShell window and change the working directory to your **myaddon** folder:
47
47
48
-
```powershell
49
-
cd c:\projects\myaddon\
50
-
```
48
+
```powershell
49
+
cd c:\projects\myaddon\
50
+
```
51
51
52
52
1. Use NPM to install our tools:
53
53
54
-
```powershell
55
-
npm i
56
-
```
54
+
```powershell
55
+
npm i
56
+
```
57
57
58
58
1. Use this shortcut command to open the project in Visual Studio Code:
59
59
60
-
```powershell
61
-
code .
62
-
```
60
+
```powershell
61
+
code .
62
+
```
63
63
64
64
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.
65
65
66
66
1. In Visual Studio Code, open the file `.env`. This contains the environment variables to use to configure project:
67
67
68
68
```
69
69
PROJECT_NAME="starter"
70
-
MINECRAFT_PRODUCT="BedrockUWP"
70
+
MINECRAFT_PRODUCT="BedrockGDK"
71
71
CUSTOM_DEPLOYMENT_PATH=""
72
72
```
73
73
74
74
-**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**).
75
75
76
-
- **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**.
76
+
-**MINECRAFT_PRODUCT**. You can choose to use either Minecraft or Minecraft Preview to debug and work with your scripts. These are the possible values: **BedrockGDK, BedrockGDK, Custom**.
77
77
Use **Custom** in case of deploy on any other path.
78
78
79
79
-**CUSTOM_DEPLOYMENT_PATH**. In case of using **Custom** for **MINECRAFT_PRODUCT**, this is the path used to generate the assets.
@@ -100,7 +100,4 @@ With this starter, you've seen how to build a nice little add-on.
100
100
101
101
## Manifest
102
102
103
-
-[start](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/1_hello_world): This contains a starter add-on bare-minimum set of files.
104
-
-[1_hello_world](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/1_hello_world): This contains a starter add-on with a basic starter entity.
105
-
-[2_entities](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/2_entities): This contains a starter add-on with a full set of entities.
106
-
-[complete](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/complete): This contains the finished add-on starter example.
103
+
-[start](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/1_hello_world): This contains a starter add-on bare-minimum set of files. -[1_hello_world](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/1_hello_world): This contains a starter add-on with a basic starter entity. -[2_entities](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/2_entities): This contains a starter add-on with a full set of entities. -[complete](https://github.com/microsoft/minecraft-samples/blob/main/addon_starter/complete): This contains the finished add-on starter example.
0 commit comments