Getting Started
GUIDE EASYSo, you want to create an addon with Peanut? Well, let's dive right in!
Here's what you need to get started:
Prerequisites
NodeJS- https://nodejs.org/en/downloadVisual Studio Code(or choice of compiler) - https://code.visualstudio.com/download- A copy of Minecraft: Bedrock Edition.
Setup
Start by downloading the sample project. Grab the latest Release from GitHub.
Once installation has finished, extract the folder into a directory of your choice. This will become your project directory, and you can name it anything you want.
After extracting the folder, your folder structure should look something like this:
INFO
--- ├── PROJECT_DIRECTORY/ │ ├── NAMESPACE/ │ │ ├── plugins/ -# Used for PeanutFramework plugins. │ │ │ └── ... │ │ ├── resources/ -# Used for resource pack resources (textures, sounds, etc.) │ │ │ └── ... │ │ ├── scripts/ -# Optional, used for Script API scripts. │ │ │ └── ... │ │ └── project.ts ├── gulpfile.js ├── plugins.js └── package.json ---PROJECT_DIRECTORY- The folder to house your project's code.NAMESPACE- The folder containing your addon resources and script(s).For this example, your namespace is
peanut_example, but you can change this later.Now that your project folder is set up, open it in Visual Studio Code.
In the Explorer on the left hand side, navigate inside of the
peanut_example/, and then click onproject.tsto open it.Now navigate to the tabs in the top left, and click Terminal » New Terminal.
In the new window at the bottom of your screen, type
npm installornpm i.You should see some text fly by in your terminal; this is all of the project's required dependencies being installed.
Lastly, run the command
npm i -g peanut-framework. This will allow you to run Peanut Framework's commands.
Creating your Project
TIP
If you are already an experienced programmer, you are welcome to skip to the end of this step.
Let's take a look at how projects work, and how you can start making addons with Peanut!
With project.ts open, you might've have already begun looking at some of the example code that is already there; this is a very simple layout of what a project might look like.
When creating a new project, you need to start by making an instance of the Project class. In the example, we've done this with:
const project = new Project("peanut_example");Though the project class gives us access to all of the properties we need for our project, it does nothing on its own. For that, we need to add a line to compile the project at the end of the script when it is finished.
const project = new Project("peanut_example");
project.compile();Great, we already have a working project! However, it doesn't really have anything to it, so let's change that!
First, let's modify the pack manifest. If you are editing the sample, just edit what is already there. Create a new name and description for your addon.
project.manifest.properties({
header: {
name: "Your New Addon",
description: "Mmm, peanut.",
},
});Fantastic! Now this addon is truly yours. There's only one thing missing... it doesn't have any features! Let's go ahead and create an example block!
project.features = [
new Block("peanut:block", "Peanut Block").singleTexture(
"peanut",
"blocks/peanut"
),
];The project.features array registers all of the contained features to the project you are working on. You do not have to initialize your features directly inside of the array like in this example.
Using the Block class, we've created a new block with the identifier peanut:block, and the name Peanut Block. It also maps the texture peanut from the /resources/textures/blocks/peanut folder to every side of the block!
Your finished code should look like this:
Collapse code snippet
const project = new Project("peanut_example");
project.manifest.properties({
header: {
name: "Your New Addon",
description: "Mmm, peanut.",
},
});
project.features = [
new Block("peanut:block", "Peanut Block").singleTexture(
"peanut",
"blocks/peanut"
),
];
project.compile();Compiling your Addon
Although you now have a working project, it's not an addon yet, which means it's not usable in Minecraft. Let's change that!
In your Terminal from earlier, run the command peanut build peanut_example
INFO
Peanut registers four terminal commands for different purposes:
peanut build <path to project directory>- Generates project behavior and resources.
peanut deploy- Deploys your latest behavior and resource pack build to Minecraft.
peanut reload <path to project directory>- Reloads plugins from your plugins directory.
peanut watch <path to project directory>- Starts a watch task for your project.This means that anytime a script in your project is saved, your project will be built, compiled, and deployed to Minecraft.
Once compilation has completed, run the command peanut deploy.
By default, your packs will be deployed to the /development_behavior_packs/ and /development_resource_packs/ folders at the default location for bedrock installations.
On windows, this can be found at:
%LocalAppData%\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\
INFO
If you want to change the location of deployment, you can create a config.yaml file in your root directory with any of the following options:
- behaviorPackSource [source path to deploy from, defaults to './behavior_packs']
- resourcePackSource [source path to deploy from, defaults to './resource_packs']
- behaviorPackTarget [target path to deploy to, defaults to '%LOCALAPPDATA%.../development_behavior_packs']
- resourcePackTarget [target path to deploy to, defaults to '%LOCALAPPDATA%.../development_resource_packs']
You should now be able to open Minecraft, apply the behavior and resource pack to your world, and use it!
To see if it worked, try giving yourself the example block you created!
/give @s peanut:blockGood Work!
You have completed the Getting Started guide!
If you experience any issues or have a suggestion, please create an Issue.