Skip to content

Installation

Jump to bottom
Jacob McMasters edited this page Jun 18, 2024 · 8 revisions

🛠️ Prerequisites

Before you begin installing Jigsaw Block Bedrock, you will need the following:

  • Minecraft v1.21.0
  • Manifest file with latest @minecraft/server version and @minecraft/server-ui version
  • Minecraft World with Holiday Creator Features and Beta API Enabled

Here is an example of what your behavior pack manifest module import should look like:

	"modules": [
                //Other modules...
		{
			"type": "script",
			"language": "javascript",
			"uuid": "bfece0b9-1323-40e9-b6a3-38c16f90c28d",
			"entry": "scripts/index.js",
			"version": [
				1,
				0,
				0
			]
		}
	]

Here is another example of what your behavior pack manifest dependencies should look like:

	"dependencies": [
                //Other dependencies...
		{
			"module_name": "@minecraft/server",
			"version": "1.12.0-beta"
		},
		{
			"module_name": "@minecraft/server-ui",
			"version": "1.2.0-beta"
		}
	]

🤓 Installation Options

Jigsaw Block Bedrock offers 4 different methods of installation.

  • .mcaddon/.mcpack: This option is exclusively for map makers and works as a standalone version.

⬇️ Add-On Developers ⬇️

  • Compiled EXE: Downloading the compiled exe is as simple as installing the .zip from the latest release here on Github. Once you download the .zip, please unzip it and run install.exe.
  • node.js Script: You can download the script in the same way you download the exe. Once you have the script installed, please make sure you have node.js to run it.
  • Manual Install: If none of these options appeal/work for you, manual installation is also an option. This project was created using bridge. V2 and was developed primarily in Typescript. Keep in mind that the Typescript must be compiled into Javascript before trying to manually install the library.

📜 EXE/Script Installation Guide

⚠️ STAY CAUTIOUS ⚠️ Since this installation method involves an early access build script, we caution you to make a copy of your add-on as a backup before proceeding with this method. We are confident in the script and we want you to stay safe when dealing with our install script.

Upon running the exe or install script, you will be greeted with the following screen:

scriptwelcomescreen

Please enter the full path to your project's behavior pack. You can find the full path to your behavior pack here: C:\Users\user\AppData\Local\Packages\Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe\LocalState\games\com.mojang\

scriptenterresourcepack

It will now prompt you for the full path to your project's resource pack. Once again, you can find the full path to your resource pack here: C:\Users\user\AppData\Local\Packages\Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe\LocalState\games\com.mojang\

scriptincludetests

Please specify a Y (yes) or an N (no) if you would like to include our example structures and their template pools. Currently, there are two examples that you will receive if you enable this option: a complex jigsaw structure and a simple jigsaw structure. You can find their corresponding build world files in the structures/jigsaw/tests directory. If you're going into a example build world, please make sure that the Add-On is applied to the world in the world settings.

scriptupdate

Finally, you will be prompted on whether this installation is an update to a current one or not. If this is your first time installing JBB via exe/script, please specify N.

🎉 Annnd.... that's it!

If you had trouble with any installation method specified on this page, please refer to our resources on the wiki homepage.

Clone this wiki locally