Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Vite version #854

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ node_modules
.DS_Store
docs/.vitepress/dist
docs/.vitepress/.temp
docs/.vitepress/cache
*.code-workspace
yarn.lock
.vscode/settings.json
1 change: 0 additions & 1 deletion CONTRIBUTING.md

This file was deleted.

16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Bedrock Wiki
# Minecraft Bedrock Wiki

Welcome to the Bedrock Wiki!

🔗 [View the Site](https://wiki.bedrock.dev/) 🔗

✉️ [Join the discord](https://discord.gg/XjV87YN) ✉️

This wiki is a knowledge-sharing website for Technical Bedrock, containing documentation, tutorials, and general how-to information.
This wiki is a knowledge-sharing website for Minecraft Bedrock Add-Ons, containing documentation, tutorials, and general how-to information.

# Contributing

You've found a typo, couldn't get along with a guide because it was too complicated or want to write your own guide to help other users create their own addons? Then you've come to the right place!

Our Bedrock wiki is fully open source and is maintained by our lovely community. And this community grows every day! If you want to be part of this community, get help on addons or just want to expand our wiki, you can join our Discord servers:
The Bedrock wiki is fully open source and is maintained by our lovely community. And this community grows every day! If you want to be part of this community, get help on addons or just want to expand our wiki, you can join our Discord servers:

[Bedrock OSS](https://discord.gg/XjV87YN) - for wiki contributing and cool projects,
[Bedrock Add-Ons](https://discord.gg/pytC8zKHPn) - for add-on help.
- [Bedrock OSS](https://discord.gg/XjV87YN) - for wiki contributing and cool projects,
- [Bedrock Add-Ons](https://discord.gg/pytC8zKHPn) - for add-on help.

If you want to help us create more complex things, like adding a new page or fixing some typos yourself, we have a dedicated [Contribute Page](https://wiki.bedrock.dev/contribute) on our wiki, which describes every step you need to follow. If you have some questions, there are some really nice people in our [Discord Server](https://discord.gg/XjV87YN).

Expand All @@ -24,3 +24,9 @@ If you want to help us create more complex things, like adding a new page or fix
The wiki uses a custom [VitePress theme](https://vitepress.vuejs.org/), and is statically generated from the `wiki` branch into the `generated` branch.

If you are interested in helping us maintain the core platform, as opposed to the markdown articles, [join the discord](https://discord.gg/XjV87YN)!

## Running Locally

- `npm install`
- `npm run dev` (run in dev mode)
- `npm run build` (test a release mode bundle)
13 changes: 7 additions & 6 deletions docs/guide/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Addons allow us to modify the contents of our Minecraft Experience by _modifying

Addons are primarily written in [json](/guide/understanding-json), which is a structured data-format. An addon is essentially a collection of json files, images, and sounds, which modify or add to the game in some way.

:::tip Javascripting
Since this guide was written, the definition of 'Add-On' has expanded to include the Javascript scripting API. You can learn more about this API elsewhere on this site.
:::

## What's the difference between a Behavior Pack & a Resource Pack?

Addons are split into two pack types: Resource Packs, and Behavior Packs. Both can function independently, but they are most commonly used together. When you have both a Resource Pack and Behavior Pack, this is referred to as an _addon_.
Expand Down Expand Up @@ -54,19 +58,16 @@ In most cases, you will have both a RP and a BP together. These packs can commun
- An RP entity definition, which describes how your entity will _look_
- A BP entity definition, which describes how your entity will _act_

## What you have learned

:::tip
# Next

:::tip What you have learned
- Addons modify Minecraft content or add their own
- Addons are written in json
- An addon is split into the **Resource Pack** and the **Behavior Pack**: - Resource Packs contain Textures, Sounds, ... and control how the game looks - Behavior Packs contain entity-files, crafting recipes, ... and control the logic of your game
:::

## What to do now?

<BButton
link="/guide/software-preparation"
color=blue
>Check out software and preparation page!</BButton>
>Next: Software and preparation</BButton>

21 changes: 8 additions & 13 deletions docs/guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,42 +19,37 @@ mentions:
- retr0cube
---

## What are Addons?
## What are Add-Ons?

An "Addon" is the Minecraft Bedrock Edition (_Windows 10, iOS, Android, Consoles_) equivalent to Java mods. However, in contrast to Java, the Bedrock Edition API is officially maintained by Mojang instead of the community.
An "[Add-On](https://learn.microsoft.com/en-us/minecraft/creator/?view=minecraft-bedrock-stable)" is the Minecraft Bedrock Edition (_Windows 10, iOS, Android, Consoles_) equivalent to Java mods. In contrast to Java however, the Bedrock Edition API is officially maintained by Mojang instead of the community.

In general, you can think of _mods_ as _modifying_ the game, and _addons_ as _adding onto_ the game, following the development opportunities provided by Microsoft.

:::tip
Although we're very pleased with this guide, it's not the only option for getting started. Mojang maintains their own [getting started guide](https://learn.microsoft.com/en-us/minecraft/creator/documents/gettingstarted?view=minecraft-bedrock-stable&tabs=Windows10) on the Creator Platform, which you can consider following instead.
:::

## What is this guide?

This guide is a beginner tutorial, intended to walk you through the first stages of addon-creation. You will create your very own fully-functional Ghost entity, as well as an Ectoplasm item, and some other associated files.

By the end of this guide, you will have created an entire addon all by yourself, which you can play with and modify!

In this guide you will find boxes like these:
:::tip
Some very helpful information!
:::
:::warning
Attention! Watch out for these common mistakes.
:::
Watch out for these boxes! They contain very important information that could help you with problems.

## Is the guide up to date?

This guide is written for the most recent _stable_ release of Minecraft Bedrock Edition. Many things won't work in previous versions, and some will be changed in later ones. We will keep the guide as up-to-date as possible, so no need to worry.

## Appendix Pages

Alongside the step-by-step guide, we have a few other files here, which may be interesting to you:
Alongside the step-by-step guide, we have a few other pages here in this section, which you can browse at your convenience.

- [Understanding JSON](/guide/understanding-json)
- [Downloading Example Packs](/guide/download-packs)
- [Troubleshooting](/guide/troubleshooting)

## What to do after finishing the Guide

At the end of the guide section, your first addon will be done! To further expand your knowledge, consider doing these:
At the end of the guide section, your first addon will be done! To further expand your knowledge, consider the following:

- Start your project!
- To dive into the other aspects of adding onto MCBE (Minecraft Bedrock Edition), you can use the different sections' sub guides listed in the Appendix. This includes but is not limited just to custom Blocks, Biomes, advanced Items, Animation Controllers, and even JS scripts. Some sections provide more technical in-depth tutorials and documents for each relevant topic.
3 changes: 1 addition & 2 deletions docs/guide/project-setup-android.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: Project Setup Android
category: Guide
category: Extra
description: How to setup your project on Android
mentions:
- Etanarvazac
- MedicalJewel105
- TheItsNameless
- ThomasOrs
hidden: true
---

## Tools
Expand Down
56 changes: 24 additions & 32 deletions docs/guide/project-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ mentions:
- lescx
---

## Introduction

This page will guide you through the steps required to create your first "working" add-on and view it in game. If you're joining on android, you should follow this alternative guide:

<BButton
link="./project-setup-android"
color=blue
>Android guide</BButton>

## 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!
Expand All @@ -32,9 +41,11 @@ You should create a shortcut to the `com.mojang` folder on your Desktop or on yo

### Windows

_Tip: You can type %appdata% into the searchbar to jump directly into the 'C:\Users\USERNAME\AppData\' folder._
On windows, the `com.mojang` folder is located within your app-data folder.

`C:\Users\USERNAME\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang`
_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

Expand Down Expand Up @@ -66,15 +77,6 @@ We will develop our addon in `development_behavior_packs` and `development_resou

## 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")
:::
Expand All @@ -92,14 +94,10 @@ Let's create your first add-on workspace in Visual Studio Code now.

## BP Manifest

:::tip
:::tip Creating Files
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](/guide/understanding-json).
Expand Down Expand Up @@ -231,8 +229,8 @@ If you have done everything correctly, your packs should show up in Minecraft no

## Turn on Content Log

:::warning
Content log is the most useful tool you have for debugging your addons. Please do not skip this step.
:::warning Content Log
Content log is the most useful tool you have for debugging your addons. Please do not skip this step!
:::

![](/assets/images/guide/content_log.png)
Expand Down Expand Up @@ -275,21 +273,9 @@ Remember that in future, we will represent `com.mojang/development_behavior_pack
'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
## Next

:::tip What you have learned
<Checklist>

- [x] Setup your pack
Expand All @@ -298,3 +284,9 @@ Remember that in future, we will represent `com.mojang/development_behavior_pack
- [ ] Create the entity's loot, spawn rules and a custom recipe

</Checklist>
:::

<BButton
link="/guide/custom-item"
color=blue
>Next: Custom Item</BButton>
57 changes: 34 additions & 23 deletions docs/guide/software-preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ mentions:

Before you can start creating addons, you first have to install the required tools and applications. While development will be easiest on Windows 10, we have provided mobile alternatives for both Android and iOS, where applicable.

This page will provide you a list of software to install, and configuration tips for setup.

## Download Minecraft Bedrock Edition

- [Windows 10](https://www.microsoft.com/en-us/p/minecraft-for-windows-10/9nblggh2jhxj?activetab=pivot:overviewtab)
Expand Down Expand Up @@ -62,10 +64,13 @@ Many packages exist for VSCode that make editing addons easier:
[bridge.](https://bridge-core.app/) is a light-weight, dedicated IDE for Minecraft addons. It features [innovative features](https://bridge-core.app/guide/features/) such as [entity and block previews](https://bridge-core.app/guide/features/index.html#file-previews), [rich auto-completions and file validations](https://bridge-core.app/guide/features/index.html#auto-completions-and-validation) and [advanced file creation with presets](https://bridge-core.app/guide/features/index.html#advanced-file-creation).
bridge. includes a regular text editor for experienced addon creators and a tree editor to make it easy for beginners to get started with editing JSON files.

#### Next Steps
<Spoiler title="Configuring Bridge">

- [Read more on why you should use bridge.](https://bridge-core.app/guide/why-bridge)
- [Read our guide on getting started with bridge.](https://bridge-core.app/guide/index)
- [Try out bridge. online](https://editor.bridge-core.app/)
</Spoiler>


### Mobile Editors

Expand All @@ -85,63 +90,64 @@ bridge. includes a regular text editor for experienced addon creators and a tree

When choosing an image editor, it is important to keep in mind that the traditional Minecraft style is composed of simple 16X16 pixelart. There are plenty of powerful and free art programs available for you to use. However, many of these programs have more tools than you will need for Minecraft graphical design and these tools require time to learn.

:::tip
:::tip Choosing an art program
Choose a program that feels comfortable and easy for you to use. Many Addon creators use different art programs for different tasks. (Example: One might use paint․net for most of the art, and piskel for Minecraft block animations). Choose what works best for you!
:::

### Krita
Krita is a powerful open-source art programed with the goal of giving free powerful digital art tools to artists. Krita has more than enough features to cover your Minecraft needs and works on a MAC or PC.
**+ Pros:** Plenty of features including a pixel brush with an intuitive user interface.
**- Cons:** Requires a little time to become familar with the tools.

- **+ Pros:** Plenty of features including a pixel brush with an intuitive user interface.
- **- Cons:** Requires a little time to become familar with the tools.

[Download Krita](https://krita.org/en/)

### GIMP
Gimp is similar to Krita in that it is a free and open source digital art program that has a vast arrays of tools. Where Krita focuses more on illustration, GIMP focuses more on image manipulation (think Photoshop). Gimp also works on MAC or PC.
**+ Pros:** GIMP has more than enough tools for editing Minecraft art
**- Cons:** The interface is not intuitive. Even though GIMP is powerful, it requires a steep learning curve.

- **+ Pros:** GIMP has more than enough tools for editing Minecraft art
- **- Cons:** The interface is not intuitive. Even though GIMP is powerful, it requires a steep learning curve.

[Download Gimp](https://www.gimp.org/)

### Paint․net
Paint․net is a simple yet powerful image editing and art software. Paint․net may not have a vast array of tools like Krita and GIMP, but it does offer simplicity and ease of use.
**+ Pros:** Easy to use and learn.
**- Cons:** Only works on Windows.

- **+ Pros:** Easy to use and learn.
- **- Cons:** Only works on Windows.

[Download Paint.net](https://www.getpaint.net)

### Pixilart
Pixilart is a web-based pixel art software. It is extremely simple to use since it is focused on pixel art. It also has a powerful resize option that may come in handy, so that you can resize your art without losing the pixelart details.

**+ Pros:** Easy to use and learn. Curated specifically for pixel art.
**- Cons:** Must have internet connection. May be missing tools you want.
- **+ Pros:** Easy to use and learn. Curated specifically for pixel art.
- **- Cons:** Must have internet connection. May be missing tools you want.

[Use Pixilart](https://www.pixilart.com/)

### Piskel
Piskel is a web-based pixel art software with a focus of making pixelated sprites (or video game character animations). This tool, similar to Pixilart, is simple to use. This is also a great tool for making flipbooks (Minecraft block or skin animations).

**+ Pros:** Easy to use and learn. Perfect for flipbook animations
**- Cons:** Must have internet connection. Only offers the most basic tools.
- **+ Pros:** Easy to use and learn. Perfect for flipbook animations
- **- Cons:** Must have internet connection. Only offers the most basic tools.

[Download Piskel](https://www.piskelapp.com/)

### Libresprite

LibreSprite is a free and open source program for creating and animating your sprites. Based on the last GPLv2 commit of aseprite.

**+ Pros**: Basic & easy to use, customizable and curated for pixel artists.
**- Cons**: May not work on Mac, maintained only by a small community.
- **+ Pros**: Basic & easy to use, customizable and curated for pixel artists.
- **- Cons**: May not work on Mac, maintained only by a small community.

## Additional Materials

:::tip
This guide will walk you through the first stages of addon development, but it is not comprehensive! To learn more about addons, you will have to use and reference other sources of information, which we will link to here.
:::

### Join the Discord

The best place to get help with this guide is to join the [discord server](/discord).
The best place to get help with this guide is to join the [discord server](/discord)(s).

### Vanilla Packs

Expand All @@ -161,19 +167,24 @@ There are many good sources of Addon documentation. Familiarize yourself with al

- If the json format is very tricky for you, consider reading the [understanding-json guide](/guide/understanding-json).
- If you get stuck with an odd error, consider reading the [troubleshooting guide](/guide/troubleshooting).
- If you still haven't found a solution, feel free to join our [Discord server](/discord).

### Additional Links and Tools

- You can explore additional tools [here](/meta/useful-links).

## Your progress so far
# Next

:::tip What you have learned
<Checklist>

- [x] Installed the necessary software
- [x] Downloaded the Vanilla Example files
- [ ] Locate your `com.mojang` folder and create your addon's workspace.
- [ ] Locate your com.mojang folder and create your addon's workspace.
- [ ] Create the manifest and pack icon for your first addon

</Checklist>
:::

<BButton
link="/guide/project-setup"
color=blue
>Next: Project Setup</BButton>


Loading
Loading