diff --git a/docs/02-setup-main-game/05-main-scene/15-jackpot-panel.md b/docs/02-setup-main-game/05-main-scene/15-jackpot-panel.md index a6089f4..78057fd 100644 --- a/docs/02-setup-main-game/05-main-scene/15-jackpot-panel.md +++ b/docs/02-setup-main-game/05-main-scene/15-jackpot-panel.md @@ -1,11 +1,86 @@ --- sidebar_position: 15 --- - # Jackpot Setup --- ## Overview +- **Jackpot Feature** is a system where there are **multiple levels (tiers)** of prizes, usually increasing in value. This structure gives players a chance to win **smaller jackpots more frequently**, while still keeping a large top prize available. +| Tier | Description | Preview | +|-------|------------------------------|------------------------------------------------------------| +| Grand | The top prize, very rare
and often worth thousands
or even millions(especially if it's progressive)|![Grand](../img/05-main-scene/jackpot-panel/jackpot-grand.png) | +| Major | A significant prize, harder to win. | ![Major](../img/05-main-scene/jackpot-panel/jackpot-major.png) | +| Minor | A bit higher in value, still fairly common. | ![Minor](../img/05-main-scene/jackpot-panel/jackpot-minor.png) | +| Mini | The smallest and easiest to win. | ![Mini](../img/05-main-scene/jackpot-panel/jackpot-mini.png) | + +- The panel is responsive and supports both desktop and mobile layouts: + +| Orientation | Preview | +|-------------|------------------------------------------------------------| +| Desktop | ![Desktop](../img/05-main-scene/jackpot-panel/jackpot-desktop.png) | +| Mobile | ![Mobile](../img/05-main-scene/jackpot-panel/jackpot-mobile.png) | + +## Implementation + +### Core Prefabs + +- Use the prefabs located at: + + |`assets/core-assets/jackpot-package/prefabs`|![Core](../img/05-main-scene/jackpot-panel/jackpot-core-prefabs.png)| + |--------------------------------------------|--------------------------------------------------------------------| + +### Setup Steps + +#### Desktop + +- Add the jackpot prefab to your main scene. +- Set its position to **(0, 0)**. + + ![Desktop](../img/05-main-scene/jackpot-panel/jackpot-in-desktop.png) + + More info: [Platform Node Spawner](http://localhost:3000/docs/faqs/setup-cocos-scene#platform-node-spawner) + +#### Mobile + +- Configure the jackpot node for both landscape and portrait orientations. +- Use `UI Mobile Position` for a responsive layout. + + ![Mobile](../img/05-main-scene/jackpot-panel/jackpot-in-mobile.png) + + More info: [UI Mobile Position](http://localhost:3000/docs/faqs/setup-cocos-scene#ui-mobile-landscape--portrait--position) + +- Example using `Platform Node Spawner`: + + ![Mobile Spawner](../img/05-main-scene/jackpot-panel/jackpot-in-mobile-spawner.png) + + More info: [Platform Node Spawner](http://localhost:3000/docs/faqs/setup-cocos-scene#platform-node-spawner) + +### Result + +- The jackpot panel works seamlessly across all platforms and orientations. + + ![Result](../img/05-main-scene/jackpot-panel/jackpot-result.png) + + More info: [Node Spawner](http://localhost:3000/docs/faqs/setup-cocos-scene#node-spawner) + +:::tip +**Sibling Index Order:** +| Node Name | Sibling Index | Notes | +|----------------------------------------|---------------|---------------------------------------| +| `jackpot-runner-panel-desktop-spawner` | Lowest | Usually at the bottom | +| `container-jackpot-runner-mobile` | Middle | Between desktop and result panels | +| `jackpot-result-panel-spawner` | Highest | Always on top
![Result](../img/05-main-scene/jackpot-panel/jackpot-positon-result.png) | +::: + + +## Game Result Examples + +| Win Tier | Example | +|----------|------------------------------------------------------------------| +| Grand | ![Grand](../img/05-main-scene/jackpot-panel/jackpot-grand-win.jpg) | +| Major | ![Major](../img/05-main-scene/jackpot-panel/jackpot-major-win.jpg) | +| Minor | ![Minor](../img/05-main-scene/jackpot-panel/jackpot-minor-win.jpg) | +| Mini | ![Mini](../img/05-main-scene/jackpot-panel/jackpot-mini-win.jpg) | diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-core-prefabs.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-core-prefabs.png new file mode 100644 index 0000000..db147ad Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-core-prefabs.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-desktop.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-desktop.png new file mode 100644 index 0000000..792bfd1 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-desktop.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand-win.jpg b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand-win.jpg new file mode 100644 index 0000000..c4cd8cd Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand-win.jpg differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand.png new file mode 100644 index 0000000..11a4529 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-grand.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-desktop.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-desktop.png new file mode 100644 index 0000000..1ac0671 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-desktop.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile-spawner.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile-spawner.png new file mode 100644 index 0000000..a9ed622 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile-spawner.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile.png new file mode 100644 index 0000000..bf0c2cc Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-in-mobile.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major-win.jpg b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major-win.jpg new file mode 100644 index 0000000..1171935 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major-win.jpg differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major.png new file mode 100644 index 0000000..a596690 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-major.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini-win.jpg b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini-win.jpg new file mode 100644 index 0000000..8d5371c Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini-win.jpg differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini.png new file mode 100644 index 0000000..d7340e3 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mini.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor-win.jpg b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor-win.jpg new file mode 100644 index 0000000..22fb233 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor-win.jpg differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor.png new file mode 100644 index 0000000..e31288d Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-minor.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mobile.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mobile.png new file mode 100644 index 0000000..652089b Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-mobile.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-positon-result.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-positon-result.png new file mode 100644 index 0000000..9df06f1 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-positon-result.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-result.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-result.png new file mode 100644 index 0000000..e86322e Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-result.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-mobile-win.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-mobile-win.png new file mode 100644 index 0000000..ab771b7 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-mobile-win.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-win.png b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-win.png new file mode 100644 index 0000000..e3d7471 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/jackpot-panel/jackpot-status-win.png differ diff --git a/docs/faqs/03-setup-cocos-scene.md b/docs/faqs/03-setup-cocos-scene.md index 2a55f42..d2967b1 100644 --- a/docs/faqs/03-setup-cocos-scene.md +++ b/docs/faqs/03-setup-cocos-scene.md @@ -22,3 +22,27 @@ Use this configuration to control which prefabs appear based on the current plat |--------------------|----------------------|-----------------------------------------------| | **Desktop Toggle** | ✅ Enabled | Show node on desktop | | **Mobile Toggle** | ❌ Disabled | Hide node on mobile | + + +## Node Spawner + +Spawns a prefab at the same position as the original node and then removes the node. + +#### Usage + +- On scene start, the prefab replaces the node. +1. Attach the script to a placeholder node. +2. Set the `prefab` property in the Inspector. + + +## UI Mobile Landscape / Portrait Position + +Positions a node at a specific location when the device is in landscape / portrait mode on mobile. + +#### Usage + +1. Attach the script to your node. +2. Set `default Position` in the Inspector. +3. The position updates automatically in mobile landscape / portrait mode. + +![Position](./img/default-setting.png) \ No newline at end of file diff --git a/docs/faqs/img/default-setting.png b/docs/faqs/img/default-setting.png new file mode 100644 index 0000000..c9cdbbd Binary files /dev/null and b/docs/faqs/img/default-setting.png differ