create-playable-game

CLI tool để scaffold dự án playable ad game từ template.

Cài đặt & Sử dụng

Sử dụng npx (khuyến nghị)

npx create-playable-game my-game-name

Cài đặt global

npm install -g create-playable-game
create-playable-game my-game-name

Options

| Option | Mô tả | |--------|-------| | --help, -h | Hiển thị help | | --git-url | Override git repository URL | | --branch, -b | Chọn branch để clone (mặc định: main) |

Ví dụ

# Tạo project với tên "puzzle-game"
npx create-playable-game puzzle-game

# Tạo từ branch develop
npx create-playable-game puzzle-game --branch develop

# Sử dụng git URL khác
npx create-playable-game puzzle-game --git-url https://github.com/company/template.git

Sau khi tạo project

cd my-game-name
npm install
npm run dev

Cấu hình Git URL

Trước khi publish lên npm, cập nhật GIT_REPO_URL trong file index.js:

const GIT_REPO_URL = 'https://your-company-git.com/playable-template.git';

Publish lên npm

cd cli
npm login
npm publish

Cách hoạt động

1. Clone repository từ git URL
2. Tạo thư mục với tên game được chỉ định
3. Xóa thư mục .git khỏi project mới
4. Cập nhật package.json với tên game mới
5. Xóa thư mục cli khỏi project mới