mcaddon-generator 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/addon_files/BP/manifest.json +2 -2
- package/addon_files/RP/manifest.json +2 -2
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
## What is mcaddon-generator?
|
|
2
|
+
Mcaddon generator is a CLI tool dedicated to making Minecraft Bedrock addons easier to create. It handles both creating packs, and packaging them efficiently into .mcaddon files
|
|
3
|
+
### Installation
|
|
4
|
+
To install this package, you may type the following line in the terminal. Assuming you have [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed of course.
|
|
5
|
+
```
|
|
6
|
+
npm install mcaddon-generator
|
|
7
|
+
```
|
|
8
|
+
## How to create packs
|
|
9
|
+
Once you have this package installed, open file explorer and use SHIFT+ Right Click to open the terminal in the directory you want your vscode workspace file to be in. Afterwards, you can create your pack by inputting
|
|
10
|
+
```
|
|
11
|
+
mcaddon create
|
|
12
|
+
```
|
|
13
|
+
Assuming you've correctly installed the package, the terminal should ask for your packs name, description, and the author. You can skip these prompts by instead entering
|
|
14
|
+
```
|
|
15
|
+
mcaddon create --name "Example Pack" --description "PACK DESCRIPTION" --author "PACK AUTHOR"
|
|
16
|
+
// or
|
|
17
|
+
mcaddon create -n "Example Pack" -d "PACK DESCRIPTION" -a "PACK AUTHOR"
|
|
18
|
+
```
|
|
19
|
+
Once you've entered all of the required information, your packs files will automatically be generated in your ``development_behavior_packs`` and ``development_resource_packs`` folders respectively. And a new project workspace file for vscode will be generated in the current directory.
|
|
20
|
+
You can disable the vscode output by using the ``--no-vscode`` flag.
|
|
21
|
+
And change the output directory to the current one by using the ``--here`` flag.
|
|
22
|
+
|
|
23
|
+
For more information on all of the flags associated with this command, use ``mcaddon help create ``
|
|
24
|
+
## How to package your addon (Generate .mcaddon file)
|
|
25
|
+
Just like before, you'll want to open your desired output directory in the terminal. After which, you may type the following line in the terminal
|
|
26
|
+
```
|
|
27
|
+
mcaddon pack --name "Example Pack"
|
|
28
|
+
// or
|
|
29
|
+
mcaddon pack -n "Example Pack"
|
|
30
|
+
```
|
|
31
|
+
Keep in mind that this package assumes that the target files were created with the same naming scheme as ``mcaddon create`` uses. This means that when detecting your BP and RP files, it will look for files named ``ExamplePackBP`` and ``ExamplePackRP`` in the target directory.
|
|
32
|
+
|
|
33
|
+
If you used the ``--preview`` or ``--here`` flags when creating your addon,
|
|
34
|
+
you should do the same when packaging it.
|