301 lines
11 KiB
Markdown
301 lines
11 KiB
Markdown
---
|
|
title: Project Setup
|
|
category: Guide
|
|
description: How to setup your project
|
|
nav_order: 4
|
|
prefix: '4. '
|
|
mentions:
|
|
- SirLich
|
|
- sovledDev
|
|
- Joelant05
|
|
- Dreamedc2015
|
|
- BlueFrog130
|
|
- sermah
|
|
- cda94581
|
|
- MedicalJewel105
|
|
- TheItsNameless
|
|
- ThijsHankelMC
|
|
- TheHyperWhale
|
|
- stirante
|
|
- ChibiMango
|
|
- Etanarvazac
|
|
- retr0cube
|
|
- ThomasOrs
|
|
- lescx
|
|
---
|
|
|
|
## The com.mojang folder
|
|
|
|
The `com.mojang` folder is a special folder where Minecraft stores data (Addons, Worlds, Player info...). Minecraft understands this location, and all files we access or create will be placed somewhere in this folder!
|
|
|
|
You should create a shortcut to the `com.mojang` folder on your Desktop or on your mobile device, so you can easily access it at any time. The exact location of the `com.mojang` folder will depend on your device OS.
|
|
|
|
### Windows
|
|
|
|
_Tip: You can type %appdata% into the searchbar to jump directly into the 'C:\Users\USERNAME\AppData\' folder._
|
|
|
|
`C:\Users\USERNAME\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang`
|
|
|
|
### Android
|
|
|
|
Android 11 or older: `Phone > games > com.mojang`
|
|
|
|
Android 12 and newer: `Phone > Android > data > com.mojang.minecraftpe > files > games > com.mojang`
|
|
|
|
### ChromeOS
|
|
|
|
Before you can see the `com.mojang` in your files, make sure to change the `File Storage Location` to `External` in your Minecraft Settings:
|
|
|
|
- Go to `Minecraft Settings`.
|
|
- Navigate to `Settings > General > Storage`.
|
|
- Change the `File Storage Location` to `External`.
|
|
|
|
After that you can access the `com.mojang` folder in your Android Subsystem:
|
|
|
|
`My Files > Play Files > Android > data > com.mojang.minecraftpe > files > games > com.mojang`
|
|
|
|
### iOS
|
|
|
|
`My iDevice > Minecraft > games > com.mojang`
|
|
|
|
### Development Packs
|
|
|
|
We will develop our addon in `development_behavior_packs` and `development_resource_packs`. When you make changes within these folders, you can _exit and re-enter a world with the packs applied_, to automatically reload the content. This allows you to quickly test your addon without reloading Minecraft.
|
|
|
|
`resource_packs` and `behavior_packs` on the other hand contain stable addons, including those imported via `.mcpack`. We can ignore these folders for now.
|
|
|
|
## Your Workspace
|
|
|
|
:::tip
|
|
Project setup is different for android and other platforms. Consider looking into our guide for android platforms.
|
|
:::
|
|
|
|
<BButton
|
|
link="./project-setup-android"
|
|
color=blue
|
|
>Android guide</BButton>
|
|
|
|
:::tip
|
|
In this guide, BP refers to the folder you created in `development_behavior_packs` ("the behavior pack"), and RP refers to the folder you created in `development_resource_packs` ("the resource pack")
|
|
:::
|
|
|
|
First of all, you will need to create the proper folders in suitable locations and set up your workspace.
|
|
_The remainder of this guide assumes you are using VSCode. You may also follow along with other editors._
|
|
|
|
Let's create your first add-on workspace in Visual Studio Code now.
|
|
|
|
1. Open VSCode (_Visual Studio Code, the code editor_)
|
|
2. Create a folder named "`your_pack_name_RP`" in `development_resource_packs`. **I'll refer to this folder as `RP`**
|
|
3. Create a folder "`your_pack_name_BP`" in `development_behavior_packs`. **I'll refer to this folder as `BP`**.
|
|
4. Go to `File > Add folder to workspace...` and choose `BP`. Do the same with `RP`.
|
|
5. Press `File > Save Workspace as...` to save the workspace file to your Desktop. Whenever you're working on your addon, all you have to do is open the workspace by double-clicking, and you will get quick access to both BP and RP folders.
|
|
|
|
## BP Manifest
|
|
|
|
:::tip
|
|
In this guide, you will often be instructed to create files with specific names, placed in specific folders. If the folder doesn't exist yet, please create it!
|
|
:::
|
|
|
|
:::warning
|
|
Wrongly named files/folders is a common source of errors. Please check your work carefully against the examples.
|
|
:::
|
|
|
|
The manifest is a file that identifies your pack to Minecraft. Every pack has one manifest. A folder with a correctly formatted manifest will show up in Minecraft, and we consider this the "minimal" pack before we can add additional content.
|
|
|
|
Manifest files are written in `json`. If this isn't familiar to you, you can learn more about json [here](/understanding-json).
|
|
|
|
First, create a new file in your BP folder by right-clicking on the folder and selecting `New File`. Call the file `manifest.json`. To begin, you can copy paste the following code into the file.
|
|
|
|
<CodeHeader>BP/manifest.json</CodeHeader>
|
|
|
|
```json
|
|
{
|
|
"format_version": 2,
|
|
"header": {
|
|
"name": "pack.name",
|
|
"description": "pack.description",
|
|
"uuid": "...",
|
|
"version": [1, 0, 0],
|
|
"min_engine_version": [1, 16, 0]
|
|
},
|
|
"modules": [
|
|
{
|
|
"type": "data",
|
|
"uuid": "...",
|
|
"version": [1, 0, 0]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Manifest Explained
|
|
|
|
- "`format_version`" defines what version of manifest syntax you are using. Version 2 is the most recent stable version; use it.
|
|
|
|
- "`name`" is the name of your behavior pack. "`description`" will show up under it in-game. We are defining these files in "code form" so we can translate them later into other languages. For more information about localization, look [here](/concepts/text-and-translations).
|
|
|
|
- The "`UUID`" field is **essential**, and will be discussed in more detail below.
|
|
|
|
- "`version`" defines the version of your add-on. When you import an add-on with a newer version on a device with an older version installed, the more recent version will overwrite the older one. You don't need to change the version if you have the add-on in `development_*_packs` folders and only use them on private worlds.
|
|
|
|
- "`min_engine_version`" defines the minimum Minecraft client version that'll be able to read your add-on.
|
|
|
|
- In "`modules`", the "`type`" is defined to be "`data`". This makes your pack a _Behavior Pack_.
|
|
|
|
### UUID Explained
|
|
|
|
A UUID (_Universally Unique Identifier_) identifies your pack for other programs (in this case, Minecraft) to read. It looks something like this: `5c830391-0937-44d6-9774-406de66b6984`
|
|
|
|
**NEVER USE THE SAME UUID TWICE.** You can generate your own UUIDs [here](https://www.uuidgenerator.net/version4) or, if you use VSCode, you can install [this](https://marketplace.visualstudio.com/items?itemName=netcorext.uuid-generator) extension. Many other tools like _bridge._ generate UUIDS automatically. Every manifest file uses two different UUIDs.
|
|
|
|
To ensure that your add-on will work correctly you should generate two new UUID's which you will paste into the BP `manifest.json` file, at each `"..."`. When you are finished, it should look something like this:
|
|
|
|
`"uuid": "5c830391-0937-44d6-9774-406de66b6984"`
|
|
|
|
## RP Manifest
|
|
|
|
The next step is to create the `manifest.json` for the RP. The format for a resource-pack manifest is nearly identical to a BP manifests except that the `type` is `resources`, which marks the pack as a _Resource Pack_.
|
|
|
|
Copy the following code into your newly created `RP/manifest.json` and insert your own UUIDs.
|
|
|
|
<CodeHeader>RP/manifest.json</CodeHeader>
|
|
|
|
```json
|
|
{
|
|
"format_version": 2,
|
|
"header": {
|
|
"name": "pack.name",
|
|
"description": "pack.description",
|
|
"uuid": "...",
|
|
"version": [1, 0, 0],
|
|
"min_engine_version": [1, 16, 0]
|
|
},
|
|
"modules": [
|
|
{
|
|
"type": "resources",
|
|
"uuid": "...",
|
|
"version": [1, 0, 0]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Pack Icon
|
|
|
|
The pack icon is an image file which identifies how your addon will look in-game. If you have a low-resolution square image, you can use it. Otherwise, download and use this example icon:
|
|
|
|
<WikiImage src="/assets/images/guide/project-setup/pack_icon.png" alt="Pack Icon" pixelated/>
|
|
|
|
<BButton
|
|
link="/assets/images/guide/project-setup/pack_icon.png" download
|
|
color=default
|
|
>Download Image</BButton>
|
|
|
|
You should place a copy of your desired image into both the RP and the BP. The image needs to be named `pack_icon.png`
|
|
|
|
## Language Files
|
|
|
|
The last thing to do is setup language support for your addon. You will need to create a language file for both the RP and the BP. You can learn more about how Minecraft handles localization [here](/concepts/text-and-translations).
|
|
|
|
<CodeHeader>RP/texts/en_US.lang</CodeHeader>
|
|
|
|
```json
|
|
pack.name=Wiki Resource Pack
|
|
pack.description=A Ghostly Guide
|
|
```
|
|
|
|
<CodeHeader>BP/texts/en_US.lang</CodeHeader>
|
|
|
|
```json
|
|
pack.name=Wiki Behavior Pack
|
|
pack.description=A Ghostly Guide
|
|
```
|
|
|
|
<CodeHeader>RP/texts/languages.json</CodeHeader>
|
|
|
|
```json
|
|
["en_US"]
|
|
```
|
|
|
|
<CodeHeader>BP/texts/languages.json</CodeHeader>
|
|
|
|
```json
|
|
["en_US"]
|
|
```
|
|
|
|
## Checking your Work
|
|
|
|
If you have done everything correctly, your packs should show up in Minecraft now! If you don't see your pack, you should follow the [troubleshooting guide.](/troubleshooting)
|
|
|
|
|
|
|
|
## Turn on Content Log
|
|
|
|
:::warning
|
|
Content log is the most useful tool you have for debugging your addons. Please do not skip this step.
|
|
:::
|
|
|
|
|
|
|
|
Content Log is an extremely important debugging tool, which you should always have on.
|
|
|
|
Turn on both content log settings in `settings > creator`. This will show you any errors in your add-on when you enter a world with it applied. You can open the content log GUI in-game by pressing `ctrl+h` or by pressing `Content Log History` in the creator settings panel. Learn more about the content log [here](/guide/troubleshooting).
|
|
|
|
## Creating your testing world
|
|
|
|
Now we create a world to test your new add-on!
|
|
|
|
1. Click "**Create new world**";
|
|
|
|
2. Ensure that the following settings are set.
|
|
|
|
|
|
|
|
|
|
3. Now activate your behavior pack, and your resource pack. You can do this by selecting the packs, and clicking 'apply'.
|
|
|
|
4. Now click '**Create**'!
|
|
|
|
---
|
|
|
|
## Your progress so far
|
|
|
|
**Here is how your project should look, after completing this page:**
|
|
|
|
Remember that in future, we will represent `com.mojang/development_behavior_packs/guide_RP/` as `RP`, and `com.mojang/development_behavior_packs/guide_BP/` as `BP`.
|
|
|
|
<FolderView :paths="[
|
|
'com.mojang/development_resource_packs/guide_RP/manifest.json',
|
|
'com.mojang/development_resource_packs/guide_RP/pack_icon.png',
|
|
'com.mojang/development_resource_packs/guide_RP/texts/en_US.lang',
|
|
'com.mojang/development_resource_packs/guide_RP/texts/languages.json',
|
|
'com.mojang/development_behavior_packs/guide_BP/manifest.json',
|
|
'com.mojang/development_behavior_packs/guide_BP/pack_icon.png',
|
|
'com.mojang/development_behavior_packs/guide_BP/texts/en_US.lang',
|
|
'com.mojang/development_behavior_packs/guide_BP/texts/languages.json',
|
|
]"></FolderView>
|
|
|
|
## What you have learned
|
|
|
|
:::tip What you have learned:
|
|
|
|
- What the com.mojang folder is, where it is and what folders it contains
|
|
- How to setup your workspace
|
|
- What a `manifest.json` file is
|
|
- How to use UUIDs
|
|
- How to create an icon for your addon
|
|
- What a `.lang` file is
|
|
|
|
:::
|
|
|
|
## Your progress so far
|
|
|
|
<Checklist>
|
|
|
|
- [x] Setup your pack
|
|
- [ ] Create a custom item
|
|
- [ ] Create a custom entity
|
|
- [ ] Create the entity's loot, spawn rules and a custom recipe
|
|
|
|
</Checklist>
|