diff --git a/docs/02-setup-main-game/05-main-scene/08-free-round.md b/docs/02-setup-main-game/05-main-scene/08-free-round.md index 386b091..2307899 100644 --- a/docs/02-setup-main-game/05-main-scene/08-free-round.md +++ b/docs/02-setup-main-game/05-main-scene/08-free-round.md @@ -11,117 +11,117 @@ description: Display and manage remaining free rounds in the game. - Handles the **display** and **logic** for tracking remaining free rounds in a slot game. - Supports both **desktop** and **mobile**, including animation and event handling. -| Orientation | Preview | -|-------------|---------| -| Desktop | ![Desktop](../img/05-main-scene/freeround-counter/overview-freeround-desktop.png) | -| Mobile | ![Mobile](../img/05-main-scene/freeround-counter/overview-freeround.png) | +| Platform | Preview | +|----------|---------| +| Desktop | ![Desktop](../img/05-main-scene/freeround-counter/overview-freeround-desktop.png) | +| Mobile | ![Mobile](../img/05-main-scene/freeround-counter/overview-freeround.png) | --- -## Implementation +## Implementation ### Prefab Location -#### In Core +- Copy or parse prefabs from core to game assets. -| Path | Example | -|---------------------------------------------------------------------|------------------------------------------------------------------------------------------| -| `assets\core-assets\hyper-core\packages\freeround-count-box\prefabs` |
![Core Prefab](../img/05-main-scene/freeround-counter/freeround-path-prefabs.png)
| +#### Core -#### In Game +| Path | Preview | +|------|---------| +| `assets/core-assets/hyper-core/packages/freeround-count-box/prefabs` | ![Desktop](../img/05-main-scene/freeround-counter/freeround-path-prefabs.png) | -| Path | Example | -|-----------------------------------|---------------------------------------------------------------------------------------------------| -| `assets\game-assets\prefabs` |
![Copied Prefab](../img/05-main-scene/freeround-counter/freeround-path-prefabs-in-game.png)
| +#### Game + +| Path | Preview | +|------|---------| +| `assets/game-assets/prefabs` |![Preview](../img/05-main-scene/freeround-counter/freeround-path-prefabs-in-game.png) | + +--- ### General Setup -![Copied Prefab](../img/05-main-scene/freeround-counter/freeround-counter-general.png) +- Ensure the script references the correct nodes. -- Component that manages and displays the free rounds counter. +![General](../img/05-main-scene/freeround-counter/freeround-counter-general.png) -![Copied Prefab](../img/05-main-scene/freeround-counter/freeround-counter-setting-general.png) +- Manages and displays the remaining free round count in-game. -**platform** **(*)**: Desktop / Mobile +![Desktop](../img/05-main-scene/freeround-counter/freeround-counter-setting-general.png)" -| Property | Description | -|---------------|------------------------------------------| -| `duration` | Animation duration in seconds (fade In/Out) | -| `content` | Container node for the counter | -| `labelLeft` | Label displaying remaining free rounds | +| Property | Description | +|---------------|--------------------------------------------| +| `duration` | Duration of fade in/out animation (seconds) | +| `content` | Container node for the counter | +| `labelLeft` | Label showing remaining free rounds | --- ### Platform Setup +- Ensure that the desktop and mobile prefabs are positioned differently in the main game scene for proper layout on each platform. + #### Desktop -![Overview](../img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png) +![Desktop](../img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png) -| Component | Description | -|--------------------------|---------------------------------------------------------------------------------------------------------------| -| `Platform-ui-controller` | [Platform UI Controller](http://localhost:3000/docs/faqs/setup-cocos-scene#Platform-ui-controller) | +| Component | Description | +|-------------------------|-------------| +| `Platform-ui-controller` | [View Setup](http://localhost:3000/docs/faqs/setup-cocos-scene#platform-ui-controller) | -#### Assets Desktop - -| Path in Game | Example | -|--------------------------|---------------------------------------------------------------------------------------------------------------| -| `assets\game-assets\textures\desktop\preloads\main-game\custom-scale` | ![Assets Desktop](../img/05-main-scene/freeround-counter/assets-freeround-desktop.png) | - ---- - #### Mobile -![Overview](../img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png) +![Desktop](../img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png) -| Component | Description | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------| -| `Platform-ui-controller` | [Platform UI Controller](http://localhost:3000/docs/faqs/setup-cocos-scene#Platform-ui-controller) | -| `UI Mobile Position` | [UI Mobile Position](http://localhost:3000/docs/faqs/setup-cocos-scene#ui-mobile-landscape--portrait--position) | +| Component | Description | +|-------------------------|-------------| +| `Platform-ui-controller` | [View Setup](http://localhost:3000/docs/faqs/setup-cocos-scene#platform-ui-controller) | +| `UI Mobile Position` | [Mobile Position Setup](http://localhost:3000/docs/faqs/setup-cocos-scene#ui-mobile-landscape--portrait--position) | +--- -#### Assets Mobile +### Asset Setup -| Path in Game | Example | -|--------------------------|---------------------------------------------------------------------------------------------------------------| -| `assets\game-assets\textures\mobile\preloads\main-game\custom-scale` | ![Assets Mobile](../img/05-main-scene/freeround-counter/assets-freeround-mobile.png) | +#### Desktop -#### Common Assets +| Path | Preview | +|------|---------| +| `assets/game-assets/textures/desktop/preloads/main-game/custom-scale` | ![Assets Desktop](../img/05-main-scene/freeround-counter/assets-freeround-desktop.png) | -- Free Round Background: -![Assets Mobile](../img/05-main-scene/freeround-counter/assets-freeround-background.png) +#### Mobile -🔗 More Info To Pack Assets: [Game Asset Structure](http://localhost:3000/docs/category/game-asset-structure) +| Path | Preview | +|------|---------| +| `assets/game-assets/textures/mobile/preloads/main-game/custom-scale` | ![Assets Mobile](../img/05-main-scene/freeround-counter/assets-freeround-mobile.png) | + +#### Common + +- **Free Round Background** + ![Assets Mobile](../img/05-main-scene/freeround-counter/assets-freeround-background.png) + +🔗 More: [Game Asset Structure](http://localhost:3000/docs/category/game-asset-structure) :::tip - - **Position and Size**: Follow game design. - - **Asset Packing**: Use separate texture for Desktop and Mobile. +- **Position & Size**: Follow the game design layout. +- **Asset Packing**: Use separate textures for Desktop and Mobile. ::: +--- ### Font Setup - - - - - - - - - - - -
Preview
![Add Font](../img/05-main-scene/freeround-counter/add-font.png)
+| Preview | +|---------| +| ![Assets Mobile](../img/05-main-scene/freeround-counter/add-font.png) | -## Game Result Examples +--- -*To show the free round popup, make sure the main scene includes the popup panel.* -* More Info: [Popup Panel](http://localhost:3000/docs/setup-main-game/main-scene/popup-panel#multiple-popup-panel) +## Game Result Example -|Platform|Popup|Action|Result| -|--------|-----|------|------| -|Desktop|![Desktop](../img/05-main-scene/freeround-counter/popup-freeround-counter-desktop.png)|click → Start|![Add Font](../img/05-main-scene/freeround-counter/overview-freeround-desktop.png)| -|Mobile|![Mobile](../img/05-main-scene/freeround-counter/popup-freeround-counter-mobile.png)|click → Start|![Add Font](../img/05-main-scene/freeround-counter/overview-freeround.png)| +Make sure the main scene includes the popup panel. +🔗 [See Popup Panel Guide](http://localhost:3000/docs/setup-main-game/main-scene/popup-panel#multiple-popup-panel) +| Platform | Popup | Action | Result | +|----------|--------|---------------|--------| +| Desktop | ![Popup Desktop](../img/05-main-scene/freeround-counter/popup-freeround-counter-desktop.png) | Click → Start | ![Result Desktop](../img/05-main-scene/freeround-counter/overview-freeround-desktop.png) | +| Mobile | ![Popup Mobile](../img/05-main-scene/freeround-counter/popup-freeround-counter-mobile.png) | Click → Start | ![Result Mobile](../img/05-main-scene/freeround-counter/overview-freeround.png) | diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setting-general.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setting-general.png index bb0bace..f013026 100644 Binary files a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setting-general.png and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setting-general.png differ