Mbext Project Guide

@mbext/project เป็นเครื่องมือจัดการ Project สำหรับ Minecraft Bedrock Edition Add-on ที่ช่วยให้นักพัฒนาสามารถสร้าง พัฒนา และแจกจ่ายโปรเจกต์ได้อย่างมีประสิทธิภาพ

หากต้องการรู้ลึกอ่าน คู่มือการใช้งาน เพื่อเรียนรู้เพิ่มเติม

• 🔧 รองรับการพัฒนาด้วย JavaScript และ TypeScript
• 📦 จัดการ Dependencies อัตโนมัติ
• 🚀 สร้าง Project ใหม่ผ่านระบบโต้ตอบ (Interactive CLI)
• 🔄 โหมดการพัฒนาพร้อม Hot Reloading
• 🏭 สร้างไฟล์สำหรับการใช้งานจริงที่มีการบีบอัด
• 📝 การคอมไพล์ที่สะดวกสำหรับการแจกจ่าย Add-on

คุณสามารถใช้งาน @mbext/project ได้โดยตรงผ่าน npx โดยไม่จำเป็นต้องติดตั้งแบบ Global:

npx @mbext/project <command>

npx @mbext/project init

คำสั่งนี้จะนำคุณไปสู่กระบวนการสร้าง Project ใหม่ โดยถามชุดคำถามต่อไปนี้:

• ภาษาที่ใช้: เลือกระหว่าง JavaScript หรือ TypeScript
• **ชื่อ Project **: ตั้งชื่อ Project ของคุณ (ใช้อักษรตัวพิมพ์เล็ก, ตัวเลข, และเครื่องหมายยัติภังค์เท่านั้น)
• **คำอธิบาย Project **: ใส่คำอธิบายสั้นๆ เกี่ยวกับ Project
• ชื่อผู้พัฒนา: ระบุชื่อผู้พัฒนา (ใช้เครื่องหมายคอมม่าเพื่อแยกหลายชื่อ)
• เวอร์ชันขั้นต่ำของเอนจิ้น: ระบุเวอร์ชัน Minecraft ขั้นต่ำที่รองรับ (รูปแบบ x.x.x)
• ประเภทเกม: เลือกระหว่าง Stable หรือ Preview
• Dependencies: เลือก Dependencies ที่ต้องการใช้
• Add-ons เพิ่มเติม: เลือก Add-ons เพิ่มเติมที่ต้องการใช้

หลังจากตอบคำถามทั้งหมด ระบบจะสร้าง Project ใหม่พร้อมไฟล์ที่จำเป็นทั้งหมด และติดตั้ง Dependencies ที่เลือกไว้

npx @mbext/project compile
# หรือถ้าเริ่มต้น Project สำเร็จแล้ว สามารถใช้
npm run compile

ตัวเลือก:

• --original หรือ -o - ยกเลิกการสร้างใหม่และคอมไพล์ไฟล์ Project ต้นฉบับ

คำสั่งนี้จะคอมไพล์ Project และสร้างไฟล์ ZIP ที่มีชื่อตามรูปแบบ [ชื่อ Project ]-[เวอร์ชัน].zip ซึ่งพร้อมสำหรับการนำไปใช้งานใน Minecraft

npx @mbext/project update
# หรือถ้าเริ่มต้น Project สำเร็จแล้ว สามารถใช้
npm run update

ตัวเลือก:

• --all หรือ -a - อัปเดตแพ็คเกจทั้งหมดที่มาพร้อมกับ Project

คำสั่งนี้จะอัปเดตและแก้ไขการกำหนดค่า Project โดยให้คุณสามารถเปลี่ยนแปลง:

• เวอร์ชันขั้นต่ำของเอนจิ้น
• ประเภทเกม (Stable/Preview)
• Dependencies ที่ต้องการใช้
• Add-ons เพิ่มเติม

npm run dev

คำสั่งนี้จะเริ่มเซิร์ฟเวอร์การพัฒนาพร้อมเปิดใช้งาน Hot Reloading ซึ่งจะรีโหลดการเปลี่ยนแปลงโดยอัตโนมัติเมื่อคุณแก้ไขไฟล์ใน Project

npm run build

คำสั่งนี้จะสร้าง Project สำหรับการใช้งานจริง โดยสร้างเวอร์ชันที่มีการบีบอัดของ Project เพื่อประสิทธิภาพสูงสุด

หลังจากสร้าง Project ด้วย init คุณจะได้โครงสร้างไฟล์ดังนี้:

project/
├── src/                 # โฟลเดอร์สำหรับไฟล์ซอร์สโค้ด
│   └── index.js/ts      # ไฟล์เริ่มต้นสำหรับโค้ดของคุณ
├── manifest.json        # ไฟล์ manifest สำหรับ add-on
├── pack_icon.png        # ไอคอนสำหรับ add-on
├── package.json         # การกำหนดค่า Project และ dependencies
├── tsconfig.json        # การกำหนดค่า TypeScript (เฉพาะเมื่อเลือก TypeScript)
└── webpack.config.js    # การกำหนดค่า Webpack สำหรับการสร้าง Project 

คำสั่ง init ไม่ทำงาน

• ตรวจสอบว่าคุณมี Node.js เวอร์ชัน 14 หรือใหม่กว่า
• ลองรัน npm cache clean --force แล้วลองอีกครั้ง

การคอมไพล์ล้มเหลว

• ตรวจสอบว่าไฟล์ manifest.json มีการกำหนดค่าที่ถูกต้อง
• ตรวจสอบว่าไม่มีข้อผิดพลาดในโค้ดของคุณ

Hot Reloading ไม่ทำงาน

• ตรวจสอบว่า Webpack กำลังทำงานในโหมด watch (npm run dev)
• ตรวจสอบว่าไม่มีข้อผิดพลาดในคอนโซล

• Node.js 14.0.0 หรือใหม่กว่า
• npm 6.0.0 หรือใหม่กว่า
• Minecraft Bedrock Edition 1.19.0 หรือใหม่กว่า (สำหรับการทดสอบ Add-on)