add doc for freespin
@ -7,6 +7,140 @@ sidebar_position: 2
|
|||||||
## Overview
|
## Overview
|
||||||
The **Free Spin (or Free Games) Feature** awards players a set number of spins without requiring additional bets. During these spins, players can still win prizes—often larger than in the base game—without spending any of their own credits.
|
The **Free Spin (or Free Games) Feature** awards players a set number of spins without requiring additional bets. During these spins, players can still win prizes—often larger than in the base game—without spending any of their own credits.
|
||||||

|

|
||||||
## Implementation
|
|
||||||
|
|
||||||
### Prepare Assets
|
|
||||||
|
## Implementation Guide
|
||||||
|
|
||||||
|
### Prepare Assets
|
||||||
|
|
||||||
|
| Component Type | Description | Visual |
|
||||||
|
|------------------------|---------------------------------------------------|--------|
|
||||||
|
| **Core Components** | Locate the prefabs from the core package. |  |
|
||||||
|
| **Game-Specific Components** | Prefabs are already present in the main game scene. |  |
|
||||||
|
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
#### Step 1: Configure Animation Provider
|
||||||
|
|
||||||
|
- Add Free Spin background animation in **Animation Provider**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
#### Step 2: Set Display Parameters
|
||||||
|
|
||||||
|
- Configure **landscape** and **portrait** modes:
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
#### Step 3: Asset Example
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Main Scene Structure
|
||||||
|
|
||||||
|
Your scene should include the following nodes:
|
||||||
|
|
||||||
|
- **Trigger**
|
||||||
|
- **Retrigger**
|
||||||
|
- **Win**
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Component Configuration
|
||||||
|
|
||||||
|
##### 1. Free Spin Trigger
|
||||||
|
|
||||||
|
- Add fonts and textures for Free Spin trigger.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
##### 2. Free Spin Retrigger
|
||||||
|
|
||||||
|
- Add fonts and textures to show retrigger effect.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
##### 3. Free Spin Win
|
||||||
|
|
||||||
|
- Add congratulations font and texture.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
:::tip Best Practice
|
||||||
|
Follow the visual and font flow as defined by your game's design system.
|
||||||
|
:::
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Free Spins Count Box
|
||||||
|
|
||||||
|
| Step | Description | Image |
|
||||||
|
|------|-------------|-------|
|
||||||
|
| 1 | Locate prefab in Core: `freespins-count-box` |  |
|
||||||
|
| 2 | Add the prefab to main game scene |  |
|
||||||
|
| 3 | Desktop / Mobile | 
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Asset Mapping:**
|
||||||
|
|
||||||
|
| Asset Name | Node/Preference Name |
|
||||||
|
|------------|----------------------|
|
||||||
|
| `box-freespin` | `bg` |
|
||||||
|
| `freespins` | `freespins` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Sidebands (Optional)
|
||||||
|
|
||||||
|
- Optional visual element, commonly used in classic or legacy slot designs.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Setup Instructions:**
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Asset Mapping:**
|
||||||
|
|
||||||
|
| Asset Name | Node/Preference Name |
|
||||||
|
|------------|----------------------|
|
||||||
|
| `anim-free-sideband-static` | `particle-free-sideband` |
|
||||||
|
| `sideband-back` | `sideband-back` |
|
||||||
|
| `sideband` | `sideband` |
|
||||||
|
| `sideband-shine` | `sideband-shine` |
|
||||||
|
| `sideband-static` | `liquid` |
|
||||||
|
| `indicator-static` | `indicator-static` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Transition Effects (Optional)
|
||||||
|
|
||||||
|
- These transitions create visual polish between game phases.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Steps:
|
||||||
|
|
||||||
|
1. Add transition animation to the **Animation Provider**.
|
||||||
|
2. Match the animation name with the correct node.
|
||||||
|
|
||||||
|
**Example Result:**
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Final Result Examples
|
||||||
|
|
||||||
|
| Phase | Image |
|
||||||
|
|-------|-------|
|
||||||
|
| Trigger |  |
|
||||||
|
| Active Scene |  |
|
||||||
|
| Completion |  |
|
||||||
|
After Width: | Height: | Size: 5.5 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 59 KiB |
After Width: | Height: | Size: 63 KiB |
BIN
docs/03-setup-special-feature/img/freespins/both-mode-mobile.png
Normal file
After Width: | Height: | Size: 3.4 KiB |
After Width: | Height: | Size: 79 KiB |
After Width: | Height: | Size: 5.7 KiB |
After Width: | Height: | Size: 6.4 KiB |
After Width: | Height: | Size: 54 KiB |
After Width: | Height: | Size: 91 KiB |
After Width: | Height: | Size: 6.4 KiB |
After Width: | Height: | Size: 134 KiB |
After Width: | Height: | Size: 35 KiB |
After Width: | Height: | Size: 48 KiB |
After Width: | Height: | Size: 34 KiB |
BIN
docs/03-setup-special-feature/img/freespins/setup-transition.png
Normal file
After Width: | Height: | Size: 61 KiB |
BIN
docs/03-setup-special-feature/img/freespins/trigger-freespin.png
Normal file
After Width: | Height: | Size: 130 KiB |
BIN
docs/03-setup-special-feature/img/freespins/win-freespin.png
Normal file
After Width: | Height: | Size: 157 KiB |