add special win in docs
@ -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 |  |
|
||||
| **Super Win** | High payout |  |
|
||||
| **Mega Win** | Maximum payout |  |
|
||||
|
||||
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 |
|
||||
|
||||

|
||||
|
||||
:::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` |  |
|
||||
| Mobile | `assets/textures/mobile/presloads/special-wins` |  |
|
||||
|
||||
[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
|
||||
|
||||

|
||||
|
||||
##### 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` |  |
|
||||
| Mobile | `assets/textures/mobile/postloads/custom-scale/anim-special-win` |  |
|
||||
|
||||
##### Step 2: Configure Animation Settings
|
||||
|
||||
| Setting | Example |
|
||||
|------------------|---------|
|
||||
| Static Fallback |  |
|
||||
| Loop Animation |  |
|
||||
|
||||
[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.
|
||||
:::
|
||||
|
BIN
docs/02-setup-main-game/img/05-main-scene/special-win-big.png
Normal file
After Width: | Height: | Size: 378 KiB |
After Width: | Height: | Size: 8.2 KiB |
After Width: | Height: | Size: 10 KiB |
After Width: | Height: | Size: 9.0 KiB |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 63 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/special-win-loop.png
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/special-win-mega.png
Normal file
After Width: | Height: | Size: 397 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/special-win-static.png
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/special-win-super.png
Normal file
After Width: | Height: | Size: 388 KiB |
After Width: | Height: | Size: 28 KiB |