feature/add-special-win #37

Merged
huy.pham merged 8 commits from feature/add-special-win into develop 2025-05-14 17:20:03 +08:00
12 changed files with 91 additions and 0 deletions
Showing only changes of commit 410d312102 - Show all commits

View File

@ -0,0 +1,91 @@
---
sidebar_position: 14
---
# Special Win Setup
---
## Overview
Special Wins are high-value reward events in slot games, categorized based on the payout threshold:
| Win Type | Trigger Threshold | Visual Preview |
|-----------|-----------------------|----------------|
| **Big Win** | Medium payout | ![Big](../img/05-main-scene/special-win-big.png) |
| **Super Win** | High payout | ![Super](../img/05-main-scene/special-win-super.png) |
| **Mega Win** | Maximum payout | ![Mega](../img/05-main-scene/special-win-mega.png) |
Each type delivers increasing visual excitement to highlight significant player rewards.
---
## Implementation
### Core Components
| Component | Description |
|----------------------------------|---------------------------------|
| `hyper-special-win-initializer` | Initializes the special win system |
| `hyper-present-special-win` | Controls display and animation flow |
| `hyper-special-win-label-point-effect` | Shows the win amount visually |
![Component Setup](../img/05-main-scene/special-win-in-game.png)
:::tip
Place the Special Win as defined by the game design.
:::
---
### Asset Configuration
#### 1. Static Resources
Store static assets in platform-specific directories:
| Platform | Path | Preview |
|----------|------|---------|
| Desktop | `assets/textures/desktop/presloads/special-wins` | ![Desktop](../img/05-main-scene/special-win-folder-desktop.png) |
| Mobile | `assets/textures/mobile/presloads/special-wins` | ![Mobile](../img/05-main-scene/special-win-folder-mobile.png) |
[View Platform Asset Structure](http://localhost:3000/docs/category/game-asset-structure)
---
#### 2. Animation Setup
##### Animation Naming Convention
Each animation type must follow the defined naming pattern per platform:
- name type:
- bigwin
- superwin
- megawin
![Type Names](../img/05-main-scene/special-win-type-name.png)
##### Step 1: Add Animation Resources
Place animated assets in the following directories:
| Platform | Path | Preview |
|----------|------|---------|
| Desktop | `assets/textures/desktop/postloads/custom-scale/anim-special-win` | ![Desktop](../img/05-main-scene/special-win-folder-desktop-anim.png) |
| Mobile | `assets/textures/mobile/postloads/custom-scale/anim-special-win` | ![Mobile](../img/05-main-scene/special-win-folder-mobile-anim.png) |
##### Step 2: Configure Animation Settings
| Setting | Example |
|------------------|---------|
| Static Fallback | ![Static](../img/05-main-scene/special-win-static.png) |
| Loop Animation | ![Loop](../img/05-main-scene/special-win-loop.png) |
[View Animation Provider Setup](http://localhost:3000/docs/setup-main-game/main-scene/system#animation-provider-setup)
:::tip
Static and animation paths may vary by game. Adjust as needed.
:::

Binary file not shown.

After

Width:  |  Height:  |  Size: 378 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 397 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 388 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB