labag 2.2.7 → 2.2.8

package/README.md

@@ -1,14 +1,123 @@
+
 # LaBaG
 
-LaBaG 是一款使用 TypeScript 撰寫的拉霸機。  
-多模式、多種組合得分，適合用於遊戲開發與教育用途。
+LaBaG 是一款用 TypeScript 撰寫的高彈性拉霸機遊戲引擎，支援多種模式、事件監聽、組合得分，適合用於遊戲開發、教學或自訂玩法。
+
+[![npm version](https://img.shields.io/npm/v/labag.svg)](https://www.npmjs.com/package/labag)
+
+---
+
+## 特色
 
-[![npm version](https://img.shields.io/npm/v/labag.svg)](https://www.npmjs.com/package/labag)  
+- 支援多種拉霸模式（可自訂/擴充）
+- 圖案與分數組合彈性設定
+- 事件監聽機制，方便擴充互動
+- TypeScript 強型別，易於二次開發
 
 ---
 
-## 安裝方式
+## 安裝
 
 ```bash
 npm install labag
 ```
+
+---
+
+## 基本用法
+
+```typescript
+import { labag, modeList, LaBaG } from "labag";
+
+labag.init();
+while (labag.isRunning()) {
+ labag.play();
+ // 可在此取得 labag.patterns, labag.score 等資訊
+}
+console.log(labag.score);
+```
+
+### 事件監聽
+
+```typescript
+labag.addEventListener("roundEnd", (game) => {
+ console.log(game.patterns, game.marginScore, game.score);
+});
+```
+
+---
+
+## API 介紹
+
+### 主要類別
+
+- `LaBaG`：拉霸機主體，管理分數、模式、事件等
+- `Mode`：遊戲模式，決定圖案機率與特殊行為
+- `Pattern`：圖案及分數設定
+
+### 主要方法
+
+- `labag.init()`：初始化遊戲
+- `labag.play()`：執行一次拉霸
+- `labag.isRunning()`：判斷是否還可繼續遊玩
+- `labag.addMode(mode)`：新增模式
+- `labag.addEventListener(event, fn)`：註冊事件
+
+### 主要屬性
+
+- `labag.score`：目前總分
+- `labag.patterns`：本輪轉出的圖案陣列
+- `labag.modes`：目前所有模式
+
+---
+
+## 內建模式
+
+| 模式名稱   | 說明                     |
+|------------|--------------------------|
+| normal     | 標準機率分布             |
+| greenwei   | 特殊加倍與觸發條件       |
+| pikachu    | 特殊復活與替換           |
+| superhhh   | 高風險高報酬             |
+
+可自訂/擴充模式，詳見 `src/modes/` 範例。
+
+---
+
+## 圖案與分數
+
+| 圖案名稱   | 三連分數 | 雙連分數 | 單出分數 |
+|------------|----------|----------|----------|
+| gss        | 800      | 400      | 180      |
+| hhh        | 1500     | 800      | 300      |
+| hentai     | 2500     | 1200     | 500      |
+| handson    | 2900     | 1450     | 690      |
+| kachu      | 12000    | 8000     | 1250     |
+| rrr        | 20000    | 12000    | 2500     |
+
+---
+
+## 事件列表
+
+| 事件名稱       | 說明             |
+|----------------|------------------|
+| gameStart      | 遊戲開始         |
+| roundStart     | 每輪開始         |
+| rollSlots      | 轉動產生圖案     |
+| calculateScore | 計算分數         |
+| roundEnd       | 每輪結束         |
+| gameOver       | 遊戲結束         |
+
+---
+
+## 進階用法
+
+- 可自訂模式（繼承 `Mode` 並設定 eventListener）
+- 可自訂圖案與分數
+- 可串接前端 UI 或 CLI
+
+---
+
+## 授權
+
+MIT License

package/dist/labag.d.ts

@@ -14,6 +14,8 @@ export declare class LaBaG {
     score: number;
     /** 邊際分數 */
     marginScore: number;
+    /** 產生的隨機數字 */
+    randNums: number[];
     /** 當前轉出的圖案組合 */
     patterns: [Pattern | null, Pattern | null, Pattern | null];
     /** 遊戲模式列表 */

package/dist/labag.js

@@ -17,6 +17,8 @@ class LaBaG {
     score;
     /** 邊際分數 */
     marginScore;
+    /** 產生的隨機數字 */
+    randNums;
     /** 當前轉出的圖案組合 */
     patterns;
     /** 遊戲模式列表 */
@@ -33,6 +35,7 @@ class LaBaG {
         this.rounds = 0;
         this.score = 0;
         this.marginScore = 0;
+        this.randNums = [];
         this.patterns = [null, null, null];
         this.modes = [];
         this.eventListeners = {
@@ -131,6 +134,7 @@ class LaBaG {
         this.played = 0;
         this.score = 0;
         this.marginScore = 0;
+        this.randNums = [];
         this.patterns = [null, null, null];
         this.rounds = 0;
         this.emit("gameStart");
@@ -151,12 +155,12 @@ class LaBaG {
         const { ranges } = this.getCurrentConfig();
         const rangesAcc = ranges.length > 0 ? ranges[ranges.length - 1].threshold : 0;
         // 產生 3 個隨機數字
-        const randomNums = [
+        this.randNums = [
             (0, randInt_1.randInt)(1, rangesAcc),
             (0, randInt_1.randInt)(1, rangesAcc),
             (0, randInt_1.randInt)(1, rangesAcc),
         ];
-        randomNums.forEach((num, index) => {
+        this.randNums.forEach((num, index) => {
             // 根據預先計算的區間找到對應的圖案
             const match = ranges.find((r) => num <= r.threshold);
             if (match) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "labag",
-  "version": "2.2.7",
+  "version": "2.2.8",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/labag.ts

@@ -17,6 +17,8 @@ export class LaBaG {
   score: number;
   /** 邊際分數 */
   marginScore: number;
+  /** 產生的隨機數字 */
+  randNums: number[];
   /** 當前轉出的圖案組合 */
   patterns: [Pattern | null, Pattern | null, Pattern | null];
   /** 遊戲模式列表 */
@@ -34,6 +36,7 @@ export class LaBaG {
     this.rounds = 0;
     this.score = 0;
     this.marginScore = 0;
+    this.randNums = [];
     this.patterns = [null, null, null];
     this.modes = [];
     this.eventListeners = {
@@ -143,6 +146,7 @@ export class LaBaG {
     this.played = 0;
     this.score = 0;
     this.marginScore = 0;
+    this.randNums = [];
     this.patterns = [null, null, null];
     this.rounds = 0;
     this.emit("gameStart");
@@ -166,13 +170,13 @@ export class LaBaG {
     const rangesAcc =
       ranges.length > 0 ? ranges[ranges.length - 1].threshold : 0;
     // 產生 3 個隨機數字
-    const randomNums = [
+    this.randNums = [
       randInt(1, rangesAcc),
       randInt(1, rangesAcc),
       randInt(1, rangesAcc),
     ];
 
-    randomNums.forEach((num, index) => {
+    this.randNums.forEach((num, index) => {
       // 根據預先計算的區間找到對應的圖案
       const match = ranges.find((r) => num <= r.threshold);
       if (match) {

package/src/modes/greenwei.ts

@@ -44,7 +44,7 @@ export default new Mode(
         }
       }
 
-      variable.count += gssCount;
+        variable.count += gssCount;
 
       if (mode.active) {
         if (allGSS) {
@@ -85,4 +85,4 @@ export default new Mode(
       scores: [800, 400, 180],
     },
   }
-);
+);