- Setup the **Animation Name** to match the item's name in the **Animation Provider**.|  | - | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. |  | - | 4 | - Adjust **Color**, **Font** and **Font Size** in `multi-x...` and `oods-x...` according to the game design.
- Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if you need to create a Bitmap Font.|  | - - -### item-description-no-odds - Setup the `item-description-no-odds` prefab for items that have a description but no win payout: - -  - - | Step | Action | Image Reference | - | :--: | :----- | :-------------: | - | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. |
- Setup **Animation Name** to match the item's name in the **Animation Provider**.|  | - | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. |  | - | 4 | - Set the **String** and adjust **Color**, **Font** and **Font Size** in the `description` according to the game design.
- Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if you need to create a Bitmap Font. |  | - -### item-description-big - Setup the `item-description-big` prefab for items that include both a win payout and a description: - -  - - | Step | Action | Image Reference | - | :--: | :----- | :-------------: | - | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. |
 | 
 | -|Desktop | Mobile | -|:------:|:------:| -||| -|
|| - -## Prepare the assets +## Asset Preparation | Assets | Description | |--------|-------------| -||Used to setup **Rules** or image in RichText| -||Used to setup **Paytable**| +|  | Used for **Rules** or RichText images. | +|  | Used for **Paytable** setup. | -## Setup Prefabs Desktop - -| Step | Action | Description | Image Reference | -| :--: | :----- | :---------- | :---------------------------------------------------------------------------------------------: | -| 1 | Locate all template prefabs need for **Info Pages Desktop** | Search for the `desktop-hyper-info-panel` prefab. |  | -| 2 | Clone assets| Copy/Pase to game assets location, then rename the copied prefabs by removing unnecessary prefixes. |  | +## Desktop Setup +1. **Locate Template Prefabs**: + - Search for the `desktop-hyper-info-panel` prefab. + -  +2. **Clone Assets**: + - Copy and paste to the game assets location, removing unnecessary prefixes. + -  ### desktop-info-panel - - | Step | Action | Image Reference | - | :--: | :----- | :-------------: | - | 1 | Change **Color** in `page-background` follow the game design.|
- Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) to create Font Bitmap if you need it.|  | - - - Setup **Item with Description**: - -  - - | Step | Action | Image Reference | - | :--: | :----- | :-------------: | - | 1 | Setup Item with **Name** follow the game design. |
and often worth thousands
or even millions(especially if it's progressive)| | -| Major | A significant prize, harder to win. |  | -| Minor | A bit higher in value, still fairly common. |  | -| Mini | The smallest and easiest to win. |  | - -- The panel is responsive and supports both desktop and mobile layouts: - -| Orientation | Preview | -|-------------|------------------------------------------------------------| -| Desktop |  | -| Mobile |  | +**Platform Support**: +| Orientation | Preview | +|-------------|---------| +| Desktop |  | +| Mobile |  | ## Implementation ### Prepare Assets - -- Use the prefabs located at: - - |`assets/core-assets/jackpot-package/prefabs`|| - |--------------------------------------------|--------------------------------------------------------------------| +- **Prefab Location**: + - Path: `assets/core-assets/jackpot-package/prefabs` + - Example:  ### Setup -#### Jackpot runner +#### Jackpot Runner ##### Desktop - -- The node jackpot to your main scene: - -  - - More info: [Platform Node Spawner](/docs/faqs/setup-cocos-scene#platform-node-spawner) +1. **Add Node**: + - Integrate the jackpot node into the main scene. + -  ##### Mobile +1. **Configure Node**: + - Set up the jackpot node for both landscape and portrait orientations. + - Use `UI Mobile Landscape Position` and `UI Mobile Portrait Position` components for responsiveness. + -  -- Configure the jackpot node for both landscape and portrait orientations. - -- Use `UI Mobile landscape Position` and `UI Mobile portrait Position` for a responsive layout. - -  - - More info: [UI Mobile Position](/docs/faqs/setup-cocos-scene#ui-mobile-landscape--portrait--position) - -- Example using `Platform Node Spawner`: - -  - - More info: [Platform Node Spawner](/docs/faqs/setup-cocos-scene#platform-node-spawner) +2. **Platform Node Spawner**: + - Example:  #### Result Panel +- Ensure the jackpot panel displays correctly across all platforms and orientations. +-  -- The jackpot panel works seamlessly across all platforms and orientations. - -  - - More info: [Node Spawner](/docs/faqs/setup-cocos-scene#node-spawner) - -:::tip -- Follow the game design layout. -::: - +**Tip**: Follow the game design layout for positioning and sizing. ## Game Result Examples - | Win Tier | Example | -|----------|------------------------------------------------------------------| -| Grand |  | -| Major |  | -| Minor |  | -| Mini |  | +|----------|---------| +| Grand |  | +| Major |  | +| Minor |  | +| Mini |  | \ No newline at end of file diff --git a/docs/02-setup-main-game/05-main-scene/16-idle-animation.md b/docs/02-setup-main-game/05-main-scene/16-idle-animation.md index 3ca25e4..02901ec 100644 --- a/docs/02-setup-main-game/05-main-scene/16-idle-animation.md +++ b/docs/02-setup-main-game/05-main-scene/16-idle-animation.md @@ -1,26 +1,29 @@ --- sidebar_position: 16 --- + # Idle Animation ---- - ## Overview +The **Idle Animation** enhances the visual appeal of the game by animating slot symbols during idle states, providing a dynamic and engaging experience. + +| Static Preview | Animated Preview | +|--------|-------------| +|  |  | -  ## Prepare the assets | Assets | Description | |--------|-------------| -|  | Used to Setup the static sprite frame. | -|  | Used to Setup the idle animation. | +|  | Static sprite frame for the idle state. | +|  | Animation assets for the idle animation. | ## Setup Idle Animation ### Configure Settings - Create the following script: + Create a script to register the idle animation components with the dependency injection container. ```jsx title="assets/game-assets/scripts/slotty-settings/extend-slotty-setting.js" var BaseSlottySetting = p4fslot.require('slotty-setting'); var DIContainer = p4fcore.require('di-container'); @@ -44,14 +47,18 @@ BaseSlottySetting.prototype._registerInjection = function () {  ### Configure Scene -1. Search for the `idle-animation-panel` prefab. -2. Drag the "prefab" into "scene". -3. Click "Generate Panel". - - +1. **Locate Prefab**: + - Search for the `idle-animation-panel` prefab. +2. **Add to Scene**: + - Drag the prefab into the main scene. +3. **Generate Panel**: + - Click **Generate Panel** to set up the animation panel. + - :::warning -When using **prefab** directly from **core-assets**, you should convert to **Regular Node**. +When using prefabs directly from `core-assets`, convert them to a **Regular Node** to avoid reference issues.  -::: \ No newline at end of file +::: + +**Tip**: Test the idle animation in the game to ensure smooth playback and proper looping. \ No newline at end of file diff --git a/docs/02-setup-main-game/05-main-scene/17-win-limit.md b/docs/02-setup-main-game/05-main-scene/17-win-limit.md index 6ed6bc8..b8d8ad3 100644 --- a/docs/02-setup-main-game/05-main-scene/17-win-limit.md +++ b/docs/02-setup-main-game/05-main-scene/17-win-limit.md @@ -1,76 +1,54 @@ --- sidebar_position: 17 title: Win Limit -description: Display limit win +description: Display win limit popups during gameplay. --- # Win Limit ## Overview +The **Win Limit** system displays popups when specific win conditions are met, enhancing player feedback and interaction. -#### Win Limit +- **Win Limit Popup**: Appears when a playerβs win points reach a predefined threshold. + -  +- **Gamble Win Limit Popup**: Triggered during the gamble feature when the maximum number of gamble attempts (typically 5) is reached. + -  -- The **Win Limit** popup appears during gameplay when the player's win points reach a predefined threshold. - - - -#### Gamble Win Limit - -- The **Gamble Win Limit** popup is triggered during the gamble feature when the player reaches the maximum number of allowed gamble attempts (typically 5). - - - ---- - -### Prepare Assets +## Prepare Assets #### Prefab Location - -| Path | Prefab Name | -|----------------------------------------------------------|------------------------------| -| `assets/core-assets/hyper-core/packages/present/prefabs` | `present-win-limit-reached` | +| Path | Prefab Name | +|------|-------------| +| `assets/core-assets/hyper-core/packages/present/prefabs` | `present-win-limit-reached` | #### Scene Hierarchy - Place the prefab in the following scene structure: - ``` Canvas βββ [main-view] βββ [game-view] βββ [present-win-limit-reached] ``` +-  - - ---- - -### Setup +## Setup #### Assets +- Drag and drop the required images onto the corresponding nodes in the editor. +-  -- Drag and drop the required image onto the node in the editor: - - - -| Drag Sprite | Node Name | -|-------------------------|-----------------------| -| `you-won` | `you-won` | -| `win-limit-reached` | `win-limit-reached` | -| `gamble-limit-reached` | `gamble-limit-reached`| -| `btn-normal` | `btn-continue` | -| `text-continue` | `continue` | - +| Sprite | Node Name | +|--------|-----------| +| `you-won` | `you-won` | +| `win-limit-reached` | `win-limit-reached` | +| `gamble-limit-reached` | `gamble-limit-reached` | +| `btn-normal` | `btn-continue` | +| `text-continue` | `continue` | #### Font +- Use a custom font to match the win label style, aligning with the gameβs theme. +-  -- Use a **custom font** to match the win label style for your game theme. - - - ---- - -:::tip -- Follow the game design layout for assets and fonts. -- Win limit configuration may vary by game. -::: +**Tip**: +- Follow the game design layout for asset placement and font styling. +- Verify win limit configurations to ensure they match game-specific thresholds. \ No newline at end of file diff --git a/docs/02-setup-main-game/05-main-scene/18-Gamble.md b/docs/02-setup-main-game/05-main-scene/18-Gamble.md index 5cdbe0e..c1757e3 100644 --- a/docs/02-setup-main-game/05-main-scene/18-Gamble.md +++ b/docs/02-setup-main-game/05-main-scene/18-Gamble.md @@ -8,7 +8,7 @@ description: Display Gamble ## Overview -**Gamble** in slot games is a feature that lets players risk their winnings for a chance to double (or multiply) them, usually by guessing a card color. +The **Gamble Feature** allows players to risk their winnings for a chance to double or multiply them, typically by guessing a cardβs color. It is supported across desktop and mobile platforms in both landscape and portrait orientations. | Device Type | Preview | |---------------|-----------------------------------------------------------------------------| @@ -23,7 +23,7 @@ description: Display Gamble #### Scene Hierarchy -Place the node in the following scene structure: +Place the gamble node in the following scene structure: