create-mcbepack 1.0.3 → 1.0.6

package/README.md

@@ -1,197 +1,81 @@
 # create-mcbepack
 
-Interactive CLI tool for scaffolding MCBEPACK projects
+Interactive scaffolder for Minecraft Bedrock Edition add-on projects.
 
-[![npm version](https://badge.fury.io/js/create-mcbepack.svg)](https://www.npmjs.com/package/create-mcbepack)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-
-## Overview
-
-`create-mcbepack` is an interactive command-line tool that facilitates rapid scaffolding of Minecraft Bedrock Edition addon projects with best practices and modern development tooling.
-
-## Features
-
-- **Interactive Project Setup** - Guided prompts for project configuration
-- **Multiple Pack Types** - Support for Behavior Packs and Resource Packs
-- **Script API Integration** - Optional Script API setup with package selection
-- **Language Choice** - TypeScript or JavaScript support
-- **Release Channel Selection** - Choose between stable, beta, or preview releases
-- **Auto-generated Configuration** - Automatic manifest, package.json, and tsconfig generation
-- **Project Templates** - Pre-configured templates with best practices
+It creates the pack folders, manifests, optional Script API entry point, package scripts, and Minecraft development-path configuration expected by `@mcbepack/cli`.
 
 ## Usage
 
-### Quick Start
-
 ```bash
 bunx create-mcbepack
 ```
 
-### Interactive Prompts
-
-The CLI will guide you through the following steps:
-
-1. **Pack Type Selection**
-   - Choose between Behavior Pack and/or Resource Pack
-
-2. **Project Information**
-   - Project name
-   - Description
-   - Author name(s)
-   - Minimum engine version
-
-3. **Script API Configuration** (if Behavior Pack is selected)
-   - Enable/disable Script API
-   - Select programming language (TypeScript/JavaScript)
-   - Choose game release channel (stable/beta/preview)
-   - Select Script API packages to include:
-     - `@minecraft/server`
-     - `@minecraft/server-ui`
-     - `@minecraft/server-net`
-     - `@minecraft/server-admin`
-     - `@minecraft/server-gametest`
-     - `@minecraft/vanilla-data`
-     - `@minecraft/math`
-
-4. **Project Preview**
-   - Review generated file structure
-   - Confirm project creation
-
-### Example
-
-```bash
-$ bunx create-mcbepack
-
-Create MCBEPack
-
-? Select a extension type?
-  ◉ Behavior Pack
-  ◉ Resource Pack
-
-? What is the name of the project? my-awesome-addon
-? What is the description of the project? An amazing Minecraft addon
-? What is the author's name? YourName
-? What is the minimum engine version required? 1.21.0
-
-? Do you want to add a script api to behavior? Yes
-? Which language do you want to use? typescript
-? What game type would you like to use? stable
-? Which packages would you like to add?
-  ◉ @minecraft/server
-  ◉ @minecraft/server-ui
-
-Success! Created project my-awesome-addon
-   at: /path/to/my-awesome-addon
-
-Next steps:
-
-  1. cd my-awesome-addon
-  2. bun install
-  3. bun run dev
-
-Available commands:
-   • bun run dev    - Start development server
-   • bun run build:zip  - Build project
-   • bun run build:mcpack  - Build project
-   • bun run build:addon  - Build project
+The prompts ask for:
+
+- behavior pack and/or resource pack
+- project name, description, author, and minimum engine version
+- optional Script API support
+- TypeScript or JavaScript
+- stable, beta, or preview Script API release channel
+- Minecraft package modules to include
+
+## Generated Scripts
+
+Script API projects include:
+
+```json
+{
+  "scripts": {
+    "dev": "mcbepack dev",
+    "build:zip": "mcbepack build -o zip",
+    "build:mcpack": "mcbepack build -o mcpack",
+    "build:mcaddon": "mcbepack build -o mcaddon",
+    "update:stable": "mcbepack update -t stable",
+    "update:beta": "mcbepack update -t beta",
+    "update:preview": "mcbepack update -t preview"
+  }
+}
 ```
 
-## Generated Project Structure
-
-```
-my-awesome-addon/
-├── scripts/              # TypeScript/JavaScript source files (if Script API enabled)
-│   └── index.ts
-├── .env.local           # Minecraft path configuration
-├── .gitignore
-├── package.json
-├── tsconfig.json        # TypeScript configuration (if TypeScript selected)
-├── pack_icon.png
-└── README.md
+Non-script projects include the three build commands.
+
+## Generated Layout
+
+```text
+my-addon/
+|-- scripts/
+|   `-- index.ts
+|-- src/
+|   |-- behavior_pack/
+|   |   |-- manifest.json
+|   |   `-- pack_icon.png
+|   `-- resource_pack/
+|       |-- manifest.json
+|       `-- pack_icon.png
+|-- .env.local
+|-- .gitignore
+|-- package.json
+|-- README.md
+`-- tsconfig.json
 ```
 
-## Configuration Files
-
-### package.json
-
-Automatically generated with:
-
-- Project metadata
-- Script API dependencies (if enabled)
-- Development scripts
-- Peer dependencies (`@mcbepack/cli`, `@mcbepack/api`)
-
-### tsconfig.json
+Some files are only created when the selected options need them.
 
-Pre-configured TypeScript settings optimized for Minecraft addon development:
-
-- ESNext target
-- Bundler module resolution
-- Source maps disabled for production
-
-### .env.local
-
-Minecraft installation paths configuration:
-
-```env
-BASE_PATH="C:\Users\YourName\AppData\Roaming\Minecraft Bedrock\Users\Shared\games\com.mojang"
-RESOURCE_PATH="development_resource_packs"
-BEHAVIOR_PATH="development_behavior_packs"
-```
+## Local Development
 
-## Development
-
-### Building from Source
+From the repository root:
 
 ```bash
-# Clone the repository
-git clone https://github.com/bugphxne/create-mcbepack.git
-cd mcbepack/packages/create-mcbepack
-
-# Install dependencies
 bun install
-
-# Build
-bun run build
-
-# Test locally
-bun run test
-```
-
-### Project Structure
-
-```
-create-mcbepack/
-├── src/
-│   ├── index.ts          # Main CLI entry point
-│   ├── prompt.ts         # Interactive prompts
-│   ├── types.ts          # TypeScript type definitions
-│   └── utils/
-│       ├── collect-info.ts    # Project information collection
-│       ├── create-files.ts    # File generation
-│       └── generate-files.ts  # File list generation
-├── templates/            # Project templates
-│   ├── README.md
-│   ├── tsconfig.json
-│   ├── .env.local
-│   ├── .gitignore
-│   └── pack_icon.png
-└── bin/                  # Compiled output
+bun --cwd packages/create-mcbepack run build
 ```
 
 ## Related Packages
 
-- [`@mcbepack/cli`](../cli) - Development and build tooling
-- [`@mcbepack/api`](../api) - Utility APIs for Script API
-- [`@mcbepack/common`](../common) - Shared utilities
+- [`@mcbepack/cli`](../@mcbepack/cli)
+- [`@mcbepack/api`](../@mcbepack/api)
+- [`@mcbepack/common`](../@mcbepack/common)
 
 ## License
 
-GPL-3.0 - see [LICENSE](./LICENSE) for details
-
-## Resources
-
-- [GitHub Repository](https://github.com/bugphxne/create-mcbepack)
-- [npm Package](https://www.npmjs.com/package/create-mcbepack)
-- [Documentation](https://docs.mbext.online/mcbepack)
-- [Issue Tracker](https://github.com/bugphxne/create-mcbepack/issues)
+GPL-3.0. See [LICENSE](./LICENSE).

package/{out → dist}/index.js

@@ -36,21 +36,17 @@ async function main() {
             console.log(`  ${pc.cyan("3.")} bun run dev\n`);
         }
         else {
-            console.log(`  ${pc.cyan("2.")} Start developing your project\n`);
+            console.log(`  ${pc.cyan("2.")} bun install`);
+            console.log(`  ${pc.cyan("3.")} Start developing your project\n`);
         }
+        console.log(pc.dim("Available commands:"));
         if (config.script?.enabled) {
-            console.log(pc.dim("Available commands:"));
-            console.log(pc.dim("   • bun run dev    - Start development server"));
-            console.log(pc.dim("   • bun run build:zip  - Build project"));
-            console.log(pc.dim("   • bun run build:mcpack  - Build project"));
-            console.log(pc.dim("   • bun run build:addon  - Build project"));
-        }
-        else {
-            console.log(pc.dim("Available commands:"));
-            console.log(pc.dim("   • bun run build:zip  - Build project"));
-            console.log(pc.dim("   • bun run build:mcpack  - Build project"));
-            console.log(pc.dim("   • bun run build:addon  - Build project"));
+            console.log(pc.dim("   - bun run dev             - Start development server"));
+            console.log(pc.dim("   - bun run update:stable   - Update Script API packages"));
         }
+        console.log(pc.dim("   - bun run build:zip       - Build a .zip archive"));
+        console.log(pc.dim("   - bun run build:mcpack    - Build .mcpack archive(s)"));
+        console.log(pc.dim("   - bun run build:mcaddon   - Build a .mcaddon archive"));
     }
     catch (error) {
         console.error(pc.red("\nError occurred:"), error);

package/{out → dist}/utils/collect-info.js

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from "uuid";
+import { randomUUID } from "node:crypto";
 import pc from "picocolors";
 import { getDependency } from "@mcbepack/common";
 import prompt from "../prompt";
@@ -7,9 +7,9 @@ export async function collectProjectInfo() {
     const { extensions } = await prompt.extension();
     const { name, description, author, minimumEngineVersion } = await prompt.info();
     const uuids = {
-        behavior: uuidv4(),
-        resource: uuidv4(),
-        scriptModule: uuidv4(),
+        behavior: randomUUID(),
+        resource: randomUUID(),
+        scriptModule: randomUUID(),
     };
     const config = {
         name,

package/{out → dist}/utils/create-files.js

@@ -15,10 +15,10 @@ export function createFiles(files) {
             else {
                 fs.writeFileSync(file.path, file.content);
             }
-            console.log(`  ${pc.green("✓")} ${path.relative(process.cwd(), file.path)}`);
+            console.log(`  ${pc.green("[OK]")} ${path.relative(process.cwd(), file.path)}`);
         }
         catch (error) {
-            console.error(`  ${pc.red("✗")} ${path.relative(process.cwd(), file.path)}`);
+            console.error(`  ${pc.red("[ERR]")} ${path.relative(process.cwd(), file.path)}`);
             throw error;
         }
     }
@@ -58,7 +58,7 @@ function buildFileTree(files, projectRoot) {
     return root;
 }
 function printTree(node, prefix = "", isLast = true) {
-    const connector = isLast ? "└── " : "├── ";
+    const connector = isLast ? "`-- " : "|-- ";
     if (prefix === "") {
         console.log(`  ${pc.cyan(node.name)}/`);
     }
@@ -70,7 +70,7 @@ function printTree(node, prefix = "", isLast = true) {
         const children = Array.from(node.children.values());
         children.forEach((child, index) => {
             const isLastChild = index === children.length - 1;
-            const newPrefix = prefix + (isLast ? "    " : "│   ");
+            const newPrefix = prefix + (isLast ? "    " : "|   ");
             printTree(child, newPrefix, isLastChild);
         });
     }

package/{out → dist}/utils/generate-files.js

@@ -89,16 +89,16 @@ export function generateFileList(config) {
                     dev: "mcbepack dev",
                     "build:zip": "mcbepack build -o zip",
                     "build:mcpack": "mcbepack build -o mcpack",
-                    "build:addon": "mcbepack build -o addon",
+                    "build:mcaddon": "mcbepack build -o mcaddon",
                     "update:stable": "mcbepack update -t stable",
                     "update:beta": "mcbepack update -t beta",
                     "update:preview": "mcbepack update -t preview",
                 },
-                devDependencies: Object.fromEntries(config.script.dependencies.map(dep => [dep.packageName, dep.fullVersion])),
-                peerDependencies: {
+                devDependencies: {
                     "@mcbepack/cli": "latest",
                     "@mcbepack/api": "latest",
-                    ...(config.script.language === "typescript" ? { "typescript": "latest" } : {})
+                    ...(config.script.language === "typescript" ? { "typescript": "latest" } : {}),
+                    ...Object.fromEntries(config.script.dependencies.map(dep => [dep.packageName, dep.fullVersion]))
                 }
             };
             files.push({
@@ -151,7 +151,7 @@ export function generateFileList(config) {
             modules: [
                 {
                     type: "resources",
-                    uuid: config.uuids.resource,
+                    uuid: crypto.randomUUID(),
                     version: [1, 0, 0],
                 },
             ],
@@ -178,9 +178,9 @@ export function generateFileList(config) {
                 scripts: {
                     "build:zip": "mcbepack build -o zip",
                     "build:mcpack": "mcbepack build -o mcpack",
-                    "build:addon": "mcbepack build -o addon",
+                    "build:mcaddon": "mcbepack build -o mcaddon",
                 },
-                peerDependencies: {
+                devDependencies: {
                     "@mcbepack/cli": "latest"
                 }
             }, null, 2),

package/package.json

@@ -1,27 +1,23 @@
 {
   "name": "create-mcbepack",
-  "version": "1.0.3",
-  "main": "out/index.js",
-  "type": "module",
-  "scripts": {
-    "dev": "tsc --watch",
-    "build": "tsc"
-  },
-  "bin": {
-    "create-mcbepack": "./out/index.js"
-  },
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
-  "peerDependencies": {
-    "typescript": "^5"
-  },
+  "version": "1.0.6",
+  "main": "dist/index.js",
   "dependencies": {
-    "@mcbepack/common": "^1.0.0",
+    "@mcbepack/common": "^1.0.1",
     "enquirer": "^2.4.1",
     "node-fetch": "^3.3.2",
     "nodemon": "^3.1.11",
-    "picocolors": "^1.1.1",
-    "uuid": "^13.0.0"
-  }
+    "picocolors": "^1.1.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "bin": {
+    "create-mcbepack": "./dist/index.js"
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc"
+  },
+  "type": "module"
 }

package/templates/README.md

@@ -1,47 +1,36 @@
-This is a **MCBEPACK** project bootstrapped with [`create-mcbepack`](https://npmjs.com/package/create-mcbepack)
+# MCBEPACK Project
 
-## Getting Started
+This add-on was created with `create-mcbepack`.
 
-First, install dependencies:
+## Start
+
+Install dependencies:
 
 ```bash
 bun install
 ```
 
-Then, run the development server:
+Run the development watcher:
 
 ```bash
 bun run dev
 ```
 
-You can start editing your addon by modifying files in the `src` directory. The development server will automatically watch for changes and sync them to your Minecraft development folder.
-
-## Available Commands
-
-### For general development
-
-- **`bun run build:zip`** - Build the addon as a .zip file
-- **`bun run build:mcpack`** - Build the addon as a .mcpack file
-- **`bun run build:addon`** - Build the addon as a .mcaddon file
-
-### For script development
+The dev command compiles Script API code from `scripts/` when present and syncs files from `src/behavior_pack` and `src/resource_pack` into Minecraft's development folders.
 
-- **`bun run dev`** - Start development server with file watching
-- **`bun run update:stable`** - Update the addon to the latest stable version
-- **`bun run update:beta`** - Update the addon to the latest beta version
-- **`bun run update:preview`** - Update the addon to the latest preview version
+## Build
 
-## Development
-
-Edit your addon code in the `scripts` directory. The development server will automatically:
+```bash
+bun run build:zip
+bun run build:mcpack
+bun run build:mcaddon
+```
 
-- Compile TypeScript/JavaScript code
-- Sync changes to the Minecraft development folder
-- Watch for file changes and rebuild automatically
+Build outputs are written to `dist/`.
 
-### Configuration
+## Configure Minecraft Paths
 
-Update `.env.local` to configure your Minecraft installation paths:
+Edit `.env.local` if your Minecraft Bedrock installation uses a different location:
 
 ```env
 BASE_PATH="C:\Users\YourName\AppData\Roaming\Minecraft Bedrock\Users\Shared\games\com.mojang"
@@ -49,9 +38,17 @@ RESOURCE_PATH="development_resource_packs"
 BEHAVIOR_PATH="development_behavior_packs"
 ```
 
-## Learn More
-
-To learn more about MCBEPACK, take a look at the following resources:
+## Project Structure
+
+```text
+.
+|-- scripts/
+|-- src/
+|   |-- behavior_pack/
+|   `-- resource_pack/
+|-- .env.local
+|-- package.json
+`-- tsconfig.json
+```
 
-- [MCBEPACK Documentation](https://docs.mbext.online/mcbepack) - learn about MCBEPACK features and API
-- [MCBEPACK GitHub Repository](https://github.com/bugphxne/create-mcbepack) - your feedback and contributions are welcome!
+Some folders only exist when they were selected during project creation.