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 83d5665..6550019 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 @@ -1,11 +1,102 @@ --- sidebar_position: 8 +title: Free Round Counter +description: Display and manage remaining free rounds in the game. --- -# Free Round +# Free Round Counter -> To be added +## Overview + +- 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) | --- -> To be added \ No newline at end of file +## Implementation + +### Prefab Locations + +#### In Core + +| Path | Example | +|---------------------------------------------------------------------|------------------------------------------------------------------------------------------| +| `assets\core-assets\hyper-core\packages\freeround-count-box\prefabs` |
![Core Prefab](../img/05-main-scene/freeround-counter/freeround-path-prefabs.png)
| + +#### In Game + +| Path | Example | +|-----------------------------------|---------------------------------------------------------------------------------------------------| +| `assets\game-assets\prefabs` |
![Copied Prefab](../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) + +- Component that manages and displays the free rounds counter. + +![Copied Prefab](../img/05-main-scene/freeround-counter/freeround-counter-setting-general.png) + +**(platform)**: Desktop / Mobile * + +| Property | Description | +|---------------|------------------------------------------| +| `duration` | Animation duration in seconds (fade In/Out) | +| `content` | Container node for the counter | +| `labelLeft` | Label displaying remaining free rounds | + +--- + +### Platform Setup + +#### Desktop + +| Component | Description | +|--------------------------|---------------------------------------------------------------------------------------------------------------| +| `Platform-ui-controller` | [Platform UI Controller](http://localhost:3000/docs/faqs/setup-cocos-scene#Platform-ui-controller) | + +![Overview](../img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png) + +--- + +#### Mobile + +| 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) | + +![Overview](../img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png) + +### Font Setup + + + + + + + + + + + + +
Preview
![Add Font](../img/05-main-scene/freeround-counter/add-font.png)
+ +:::tip + - **Position And Size**: Follow Game Design. +::: + + +## Game Result Examples + +|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)| + diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/add-font.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/add-font.png new file mode 100644 index 0000000..07fc0fb Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/add-font.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-general.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-general.png new file mode 100644 index 0000000..d53d430 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-general.png differ 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 new file mode 100644 index 0000000..bb0bace Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setting-general.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png new file mode 100644 index 0000000..dff17d9 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-desktop.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png new file mode 100644 index 0000000..d22d204 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-counter-setup-mobile.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs-in-game.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs-in-game.png new file mode 100644 index 0000000..435fde3 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs-in-game.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs.png new file mode 100644 index 0000000..33dcd35 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/freeround-path-prefabs.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround-desktop.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround-desktop.png new file mode 100644 index 0000000..5d8fb43 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround-desktop.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround.png new file mode 100644 index 0000000..9e51de5 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/overview-freeround.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-desktop.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-desktop.png new file mode 100644 index 0000000..6efc54e Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-desktop.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-mobile.png b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-mobile.png new file mode 100644 index 0000000..283c228 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/freeround-counter/popup-freeround-counter-mobile.png differ diff --git a/src/css/custom.css b/src/css/custom.css index 2bc6a4c..93f983c 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -28,3 +28,6 @@ --ifm-color-primary-lightest: #4fddbf; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } +.red-star { + color: red; +} \ No newline at end of file