change format
@ -199,7 +199,7 @@ Use the `template-label-auto-selection` to customize the appearance of the label
|
|||||||
#### Customize *`ui-bottom-bar-panel`* Label
|
#### Customize *`ui-bottom-bar-panel`* Label
|
||||||
Use `assets\game-assets\editor\bottom-ui\template-label-title` to customize the `ui-bottom-bar-panel`:
|
Use `assets\game-assets\editor\bottom-ui\template-label-title` to customize the `ui-bottom-bar-panel`:
|
||||||
:::info
|
:::info
|
||||||
*[Follow the same configuration as Button Auto Selection Labels](#customize-button-auto-selection-label)*
|
🔗*[Follow the same configuration as Button Auto Selection Labels](#customize-button-auto-selection-label)*
|
||||||
**Bottom bar labels include a localization component for multi-language support**
|
**Bottom bar labels include a localization component for multi-language support**
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@ -231,7 +231,7 @@ Create new node and configuration in your main scene:
|
|||||||
##### Texture Button Bar
|
##### Texture Button Bar
|
||||||
Checklist assets completed for bottom UI and button UI text
|
Checklist assets completed for bottom UI and button UI text
|
||||||
:::info
|
:::info
|
||||||
🔗 [](http://localhost:3000/docs/category/game-asset-structure)
|
🔗 Click here to follow the setup pack assets: [Here](http://localhost:3000/docs/category/game-asset-structure)
|
||||||
:::
|
:::
|
||||||

|

|
||||||
|
|
||||||
@ -457,7 +457,7 @@ To use the Multiple Popup layout, reference target `hyper-multiple-popup.prefab`
|
|||||||
|
|
||||||
- *Prepare asset to pack*.
|
- *Prepare asset to pack*.
|
||||||
|
|
||||||
🔗 Click here to follow the setup pack assets: [Complete Assets Structure Guide](http://localhost:3000/docs/category/game-asset-structure)
|
🔗 Click here to follow the setup pack assets: [Here](http://localhost:3000/docs/category/game-asset-structure)
|
||||||
|
|
||||||
| Path | Example |
|
| Path | Example |
|
||||||
|-------------------------------------------------------------|-------------------------------------------------------------------|
|
|-------------------------------------------------------------|-------------------------------------------------------------------|
|
||||||
@ -472,46 +472,115 @@ To use the Multiple Popup layout, reference target `hyper-multiple-popup.prefab`
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Setup Logo
|
## Game Logo Setup Guide
|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
The game logo is a crucial branding element that must be consistently displayed across all platforms and orientations.
|
||||||
|
|
||||||
The game logo is a key visual element used to represent the game's identity. It is displayed consistently across multiple platforms and screen orientations.
|
| Platform | Orientation | Preview |
|
||||||
|
|----------|------------|----------|
|
||||||
|
| Desktop | Standard |  |
|
||||||
|
| Mobile | Landscape |  |
|
||||||
|
| Mobile | Portrait |  |
|
||||||
|
|
||||||
| Platform | Orientation | Example Screenshot |
|
### Animation Configuration
|
||||||
|---------------|---------------|-----------------------|
|
|
||||||
| Desktop | - |  |
|
|
||||||
| Mobile | Landscape |  |
|
|
||||||
| Mobile | Portrait |  |
|
|
||||||
|
|
||||||
|
#### 1. Core Setup
|
||||||
|
Location: `assets\core-assets\hyper-core\packages\logo-animation`
|
||||||
|
|
||||||
### Setup Logo In Game
|
```typescript
|
||||||
|
// filepath: assets\core-assets\hyper-core\packages\logo-animation\hyper-logo-animation.js
|
||||||
#### Logo Desktop
|
onLoad: function () {
|
||||||

|
|
||||||
|
|
||||||
##### Platform Node Spawner Settings
|
|
||||||
|
|
||||||
:::info
|
|
||||||
*[Click here to follow the setting](#platform-node-spawner-settings)*
|
|
||||||
:::
|
|
||||||
|
|
||||||
##### Add Script Play Anim Logo
|
|
||||||
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
in script was has function get name Animation:
|
|
||||||
|
|
||||||
```jsx title="assets\core-assets\hyper-core\packages\logo-animation\hyper-logo-animation.js"
|
|
||||||
onLoad: function () {
|
|
||||||
var self = this;
|
var self = this;
|
||||||
|
// Initialize animation states
|
||||||
self.animPlay = AnimationProvider.Instance.GetAnimation('anim-logo-play');
|
self.animPlay = AnimationProvider.Instance.GetAnimation('anim-logo-play');
|
||||||
self.animIdle = AnimationProvider.Instance.GetAnimation('anim-logo-idle');
|
self.animIdle = AnimationProvider.Instance.GetAnimation('anim-logo-idle');
|
||||||
},
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### 2. Required Assets
|
||||||
|
|
||||||
|
##### Static Assets
|
||||||
|
| Platform | Location | Preview |
|
||||||
|
|----------|----------|---------|
|
||||||
|
| Desktop | `assets\game-assets\textures\desktop\preloads\main-game\custom-scale` |  |
|
||||||
|
| Mobile | `assets\game-assets\textures\mobile\preloads\main-game\custom-scale` |  |
|
||||||
|
|
||||||
|
##### Animation Assets
|
||||||
|
| Platform | Location | Preview |
|
||||||
|
|----------|----------|---------|
|
||||||
|
| Desktop | `assets\game-assets\textures\desktop\postloads\main-game\animations` |  |
|
||||||
|
| Mobile | `assets\game-assets\textures\mobile\postloads\main-game\animations` |  |
|
||||||
|
|
||||||
|
#### 3. Animation Settings
|
||||||
|
1. Configure Provider
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
2. Setup States
|
||||||
|
|
||||||
|
- In `anim-logo-play` and `anim-logo-idle`,Enable static frame for loading state:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
- Configure continuous loop playback:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Platform-Specific Setup
|
||||||
|
|
||||||
|
#### Desktop Configuration
|
||||||
|
1. Base Settings
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*Node Setup*
|
||||||
|
```typescript
|
||||||
|
Components: {
|
||||||
|
animation: 'hyper-logo-animation',
|
||||||
|
}
|
||||||
|
```
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
2. Position Guidelines
|
||||||
|
- Follow design specifications
|
||||||
|
- Avoid UI element overlap
|
||||||
|
- Consider screen layout
|
||||||
|
|
||||||
|
#### Mobile Configuration
|
||||||
|
|
||||||
|
##### Landscape Mode
|
||||||
|
1. Node Setup
|
||||||
|
```typescript
|
||||||
|
Components: {
|
||||||
|
animation: 'hyper-logo-animation',
|
||||||
|
scaling: 'landscape-logo-spine-aspect-ratio-keeper'
|
||||||
|
}
|
||||||
|
```
|
||||||
|

|
||||||
|
|
||||||
|
##### Portrait Mode
|
||||||
|
|
||||||
|
1. Node Configuration
|
||||||
|
|
||||||
|
| Component | Description |
|
||||||
|
|----------------------------|--------------------------------------------------|
|
||||||
|
| `hyper-logo-animation` | Plays and manages the logo animation |
|
||||||
|
| `node-position-by-jackpot` | Moves the logo based on the jackpot display state |
|
||||||
|
| `spine-aspect-ratio-keeper`| Keeps the logo size consistent on all screens |
|
||||||
|
|
||||||
|
|
||||||
|
2. Position Settings
|
||||||
|
|
||||||
|
| State | Position | Example |
|
||||||
|
|-------|----------|---------|
|
||||||
|
| Jackpot Active | Upper position |  |
|
||||||
|
| Jackpot Inactive | Default position |  |
|
||||||
|
|
||||||
|
:::tip Best Practices
|
||||||
|
- Test on multiple device sizes
|
||||||
|
- Verify animations load properly
|
||||||
|
- Check positioning in all game states
|
||||||
|
- Ensure consistent scaling
|
||||||
|
:::
|
BIN
docs/02-setup-main-game/img/05-main-scene/logo-anim-desktop.png
Normal file
After Width: | Height: | Size: 3.1 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-anim-loop.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-anim-mobile.png
Normal file
After Width: | Height: | Size: 2.9 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-anim-provider.png
Normal file
After Width: | Height: | Size: 8.9 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-center-align.png
Normal file
After Width: | Height: | Size: 499 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-default-size.png
Normal file
After Width: | Height: | Size: 131 KiB |
After Width: | Height: | Size: 92 KiB |
After Width: | Height: | Size: 75 KiB |
After Width: | Height: | Size: 43 KiB |
After Width: | Height: | Size: 293 KiB |
After Width: | Height: | Size: 281 KiB |
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 210 KiB |
After Width: | Height: | Size: 8.1 KiB |
After Width: | Height: | Size: 10 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/logo-static-mobile.png
Normal file
After Width: | Height: | Size: 8.9 KiB |