Merge pull request 'feature/add-setup-popup-panel' (#21) from feature/add-setup-popup-panel into develop
Reviewed-on: #21
@ -125,7 +125,11 @@ The mobile interface adapts to both landscape and portrait orientations:
|
|||||||
| Portrait |  |
|
| Portrait |  |
|
||||||
|
|
||||||
|
|
||||||
### UI Panel Desktop
|
### UI Sideband
|
||||||
|
> To Be Added:
|
||||||
|
> - Prepare the asset
|
||||||
|
> - Run helper / p4f menu or setup manually
|
||||||
|
### UI Bottom Bar Desktop
|
||||||
|
|
||||||
#### Step 1: Setup Prefab Editor
|
#### Step 1: Setup Prefab Editor
|
||||||
|
|
||||||
@ -230,18 +234,30 @@ Create new node and configuration in your main scene:
|
|||||||
### UI Panel Mobile
|
### UI Panel Mobile
|
||||||
|
|
||||||
#### Step 1: Setup Prefab
|
#### Step 1: Setup Prefab
|
||||||
| Step | Action | image |
|
|
||||||
|------|---------|--------------|
|
| Step | Action | Description | Image Reference |
|
||||||
| 1. Locate Prefab | Search for `mobile-ui` prefab |  |
|
| ---- | --------------------------- | ----------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
| 2. Place Assets | Copy to game assets location |  |
|
| 1 | Locate `mobile-ui` Prefab | Search for the `mobile-ui` prefab |  |
|
||||||
| 3. Locate Prefab | Search for `buy-feature` prefab |  |
|
| 2 | Clone Assets | Copy the required assets |  |
|
||||||
|
| 3 | Paste Assets | Paste into: `assets/game-assets/prefabs/mobile` | - |
|
||||||
|
| 4 | Locate `buy-feature` Prefab | Search for the `buy-feature` prefab |  |
|
||||||
|
| 5 | Paste Prefab | Paste into: `assets/game-assets/prefabs/mobile` | - |
|
||||||
|
|
||||||
|
|
||||||
|
:::tip File Structure
|
||||||
|
Maintain this directory structure for proper prefab references:
|
||||||
|
```
|
||||||
|
assets/
|
||||||
|
└── game-assets/
|
||||||
|
└── prefabs/
|
||||||
|
└── mobile/
|
||||||
|
├── Exp: mobile-ui.prefab
|
||||||
|
└── Exp: buy-feature.prefab
|
||||||
|
```
|
||||||
|
:::
|
||||||
|
|
||||||
#### Step 2: Rename Prefabs
|
#### Step 2: Rename Prefabs
|
||||||
|
|
||||||
```jsx title="The folder structure is as follows:"
|
|
||||||
assets\game-assets\prefabs\mobile
|
|
||||||
```
|
|
||||||
|
|
||||||
Rename the copied prefabs by removing unnecessary prefixes:
|
Rename the copied prefabs by removing unnecessary prefixes:
|
||||||
| Prefix to Remove | Final Name |
|
| Prefix to Remove | Final Name |
|
||||||
|------------------|----------------------|
|
|------------------|----------------------|
|
||||||
@ -262,7 +278,7 @@ Create new node and configuration in your main scene:
|
|||||||
|
|
||||||
#### Step 4: Apply Textures
|
#### Step 4: Apply Textures
|
||||||
|
|
||||||
##### Texture Mobile Ui
|
##### Texture Mobile UI
|
||||||
✅ Checklist assets completed for Mobile UI
|
✅ Checklist assets completed for Mobile UI
|
||||||
🔗 [Follow is by Complete Assets Structure Guide](http://localhost:3000/docs/category/game-asset-structure):
|
🔗 [Follow is by Complete Assets Structure Guide](http://localhost:3000/docs/category/game-asset-structure):
|
||||||

|

|
||||||
@ -385,6 +401,56 @@ If the game have design animation for background, we will do this step.
|
|||||||
|
|
||||||
## Setup Popup Panel
|
## Setup Popup Panel
|
||||||
|
|
||||||
> To Be Added:
|
### Overview
|
||||||
> - Prepare the asset
|
|
||||||
> - Run helper / p4f menu or setup manually
|
A popup is a temporary UI element that overlays the main content to provide additional information or options to the user.
|
||||||
|
|
||||||
|
||||
|
||||||
|
|---------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------|
|
||||||
|
|
||||||
|
|
||||||
|
### Popup in the Game
|
||||||
|
The popup panel is already integrated into the main scenes `template-main-game`.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
| **Node Type** | **Location Description** | **Screenshot** |
|
||||||
|
| -------------------- | ----------------------------- | ------------------------------------------------------------------------|
|
||||||
|
| **Definition Node** | Before configuring the popup prefab |  |
|
||||||
|
| **Positioning Node** | After adjusting the prefab's position in scene |  |
|
||||||
|
|
||||||
|
#### Detail configuring:
|
||||||
|
|
||||||
|
##### Multiple Popup Panel:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
To use the Multiple Popup layout, reference target `hyper-multiple-popup.prefab` in core:
|
||||||
|
:::info
|
||||||
|
**Path** : *assets/core-assets/hyper-core/packages/popup-panel/prefabs/hyper-multiple-popup.prefab*
|
||||||
|
:::
|
||||||
|
|
||||||
|
##### Manual Popup Panel:
|
||||||
|
|
||||||
|
- This popup is self-configured using shared textures and layout structure.
|
||||||
|
- The color theme and style may vary depending on the game design.
|
||||||
|
|
||||||
|
⚠️ Note:
|
||||||
|
The **Exit Game** Popup only appears in **Desktop**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
##### Texture Path & Asset Info:
|
||||||
|
✅ Exit popup textures have been successfully packed.
|
||||||
|
🔗 Refer to the full asset structure guide: [Complete Assets Structure Guide](http://localhost:3000/docs/category/game-asset-structure)
|
||||||
|
|
||||||
|
**Texture Path:**:
|
||||||
|
`assets\game-assets\textures\desktop\preloads\main-game\exit`
|
||||||
|
|
||||||
|
**Preview Result**:
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
BIN
docs/02-setup-main-game/img/05-main-scene/popup-after.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-before.png
Normal file
After Width: | Height: | Size: 1.9 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-credit-game.png
Normal file
After Width: | Height: | Size: 139 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-disconnet.png
Normal file
After Width: | Height: | Size: 227 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-exit-game.png
Normal file
After Width: | Height: | Size: 269 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-exit-in-game.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-multi-panel.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
docs/02-setup-main-game/img/05-main-scene/popup-multi.png
Normal file
After Width: | Height: | Size: 17 KiB |
After Width: | Height: | Size: 40 KiB |