diff --git a/docs/02-setup-main-game/05-main-scene/10-desktop-bottom-bar-ui.md b/docs/02-setup-main-game/05-main-scene/10-desktop-bottom-bar-ui.md index c57f2ea..aaebffe 100644 --- a/docs/02-setup-main-game/05-main-scene/10-desktop-bottom-bar-ui.md +++ b/docs/02-setup-main-game/05-main-scene/10-desktop-bottom-bar-ui.md @@ -5,62 +5,48 @@ sidebar_position: 10 The bottom bar UI on desktop provides a functional interface for gameplay control +--- + ### Overview - Full bottom bar with all controls visible - Horizontal layout maximizing screen width ---- +![Desktop Bottom Bar UI Layout](../img/05-main-scene/bottom-ui-desktop.png) -## Prepare Prefabs +## Implementation -### Step 1: ui-bottom-bar-panel +### Step 1: Set Up Prefab Editor -**Copy** `template-new-ui-bottom-bar-panel` -from `assets\core-assets\hyper-core\packages\ui\desktop-ui\prefabs\template-ui-bottom-bar-panel` - -![Add Symbol Texture](../img/05-main-scene/add-texture-bottom-bar-prefab.png) - -**Past & rename** `assets\game-assets\prefabs\ui-bottom-bar-panel.prefab` -:::warning -Must rename to **ui-bottom-bar-panel** -::: - -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/to-ui-bottom-bar.png) - - -### Step 2: template-label - -**Copy 2 prefab** `template-label-auto-selection` & `template-label-title` - -**From** `assets\core-assets\hyper-core\packages\ui\desktop-ui\editor\` - -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/from-label.png) - -**To** `assets\game-assets\editor\bottom-ui\` - -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/to-label.png) - -### Step 3: template-label-auto-selection - -**To and rename** `template-label-auto-selection` & `template-label-title` - -From `assets\core-assets\hyper-core\packages\ui\desktop-ui\prefabs\` - -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/from-button-auto.png) - -**To** `assets\game-assets\prefabs\` - -:::warning -Must rename to **button-auto-selection** -::: - -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/to-button-auto.png) +| Step | Action | image | +|------|---------|--------------| +| 1. Locate Prefab | Search for `ui-bottom-bar-panel` prefab | ![Locate Prefabs](../img/05-main-scene/add-texture-bottom-bar-prefab.png) | +| 2. Find Assets | Navigate to `core/editor` directory | ![Copy UI Folder](../img/05-main-scene/add-texture-label-prefab.png) | +| 3. Clone Assets | Copy / Paste to game assets location | ![Asset Placement](../img/05-main-scene/editor-texture-label-prefab.png) | --- -## Edit prefab +### Step 2: Configure Prefabs -### Step 1: button-auto-selection +#### Core Prefabs Structure +Navigate to the location where the prefabs: `assets\core-assets\hyper-core\packages\ui\desktop-ui\prefabs\` +![Directory Structure](../img/05-main-scene/add-texture-bottom-bar-prefab2.png) + +#### Rename Prefabs +Rename the copied prefabs by removing unnecessary prefixes: +| Prefix to Remove | Original Prefab Name | Final Name | +|------------------|----------------------|------------| +| `template-new-` | `template-new-ui-bottom-bar-panel` | `ui-bottom-bar-panel` | +| `template-` | `template-button-auto-selection` | `button-auto-selection` | + + +```jsx title="The folder structure is as follows:" + assets\game-assets\prefabs +``` + + +![Prefab Naming Example](../img/05-main-scene/rename-prefab.png) + +#### Customize *`button-auto-selection`* Label **Follow Design:** Use the `template-label-auto-selection` to customize the appearance of the label inside the `button-auto-selection` prefab. @@ -73,11 +59,10 @@ Use the `template-label-auto-selection` to customize the appearance of the label ![Label Configuration Options](../img/05-main-scene/option-for-label.png) -### Step 2: template-label-title - +#### Customize *`ui-bottom-bar-panel`* Label Use `assets\game-assets\editor\bottom-ui\template-label-title` to customize the `ui-bottom-bar-panel`: :::info -πŸ”—[Follow the same configuration as button-auto-selection](#edit-prefab) +πŸ”—[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 ::: @@ -92,33 +77,29 @@ The `FormatText` property controls text formatting behavior for label components --- -## Setup Main Scene +### Step 3: Set Up UI In Main Scenes -**Create new node** and **configuration** in your main scene: +Create new node and configuration in your main scene: +![main scenes](../img/05-main-scene/set-positon-bottom-bar.png) -![main scenes](../img/05-main-scene/set-positon-bottom-bar.png) +#### Platform Node Spawner Settings πŸ”— Details: [Platform Node Spawner](http://localhost:3000/docs/faqs/setup-cocos-scene#platform-node-spawner) -**Position Y** : normally is -415 - ---- - -## Apply Textures - -**Checklist assets** completed for bottom UI and button UI text +### Step 4: Apply Textures +#### Texture Button Bar +Checklist assets completed for bottom UI and button UI text :::info πŸ”— Details: [Game Asset Structure](http://localhost:3000/docs/category/game-asset-structure) ::: ![main scenes](../img/05-main-scene/prepare-ui-bottom-bar.png) -**Run the Helper Tool** to configure the bottom bar UI helper. +#### Run the Helper Tool + +To configure the bottom bar UI helper. :::info πŸ”—Details: [UI Bottom Bar Desktop Helper](http://localhost:3000/docs/submodule/hyper-editor-package#mobile-ui-helper) ::: -![Add Symbol Texture](../img/05-main-scene/ui-bottom-bar/helper.png) - - --- \ No newline at end of file diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-button-auto.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-button-auto.png deleted file mode 100644 index 79dbb66..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-button-auto.png and /dev/null differ diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-label.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-label.png deleted file mode 100644 index cce277e..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/from-label.png and /dev/null differ diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/helper.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/helper.png deleted file mode 100644 index d18299f..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/helper.png and /dev/null differ diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-button-auto.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-button-auto.png deleted file mode 100644 index a2477fc..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-button-auto.png and /dev/null differ diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-label.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-label.png deleted file mode 100644 index a5827dc..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-label.png and /dev/null differ diff --git a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-ui-bottom-bar.png b/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-ui-bottom-bar.png deleted file mode 100644 index f0c391f..0000000 Binary files a/docs/02-setup-main-game/img/05-main-scene/ui-bottom-bar/to-ui-bottom-bar.png and /dev/null differ diff --git a/docs/git-using.rar b/docs/git-using.rar deleted file mode 100644 index 7b15a67..0000000 Binary files a/docs/git-using.rar and /dev/null differ diff --git a/docs/git-using/01-git-using.md b/docs/git-using/01-git-using.md deleted file mode 100644 index 6167f22..0000000 --- a/docs/git-using/01-git-using.md +++ /dev/null @@ -1,136 +0,0 @@ -# USING FORK - ---- -### AMEND - -**BEFORE** - -You already push some file and want to add more to this commit. - -![Add Symbol Texture](./img/amend-1.png) - -Your local change - -![Add Symbol Texture](./img/amend-2.png) - -**AFTER** - -You can see all file local change will appear in your commit. - -![Add Symbol Texture](./img/amend-2.png) - -#### Step1: Stage all your local change - -![Add Symbol Texture](./img/amend-3.png) - -#### Step2: Check Amend & Click Amend Last Commit - -![Add Symbol Texture](./img/amend-4.png) - ---- -### REBASE - -**BEFORE** - -![Add Symbol Texture](./img/before.png) - -**AFTER** - -![Add Symbol Texture](./img/after.png) - -#### Step1: Amend or Commit all your local change. -#### Step2: Right click rebase where you want - -![Add Symbol Texture](./img/rebase-1.png) - -#### Step2: Click rebase - -![Add Symbol Texture](./img/rebase-2.png) -:::warning -If you missing step 1, this popup will appear. Back to step 1 and do it again. -![Add Symbol Texture](./img/rebase-3.png) -::: - -#### Step3: Finish. -:::warning -With no conflict, you can see the result like image After. - -If conflict, scroll down to check how to **RESOLVE CONFLICT** -::: ---- -### DROP COMMIT -In this case: I want to create **PullRequest** merge to **develop** but only commit **test2**. -My branch **feature/test2** must split from **develop** and only have one commit **test2**. - -**BEFORE** - -![Add Symbol Texture](./img/drop-1.png) - -**AFTER** - -![Add Symbol Texture](./img/drop-4.png) - -#### Step1: Amend or Commit all your local change. - -#### Step2: - -![Add Symbol Texture](./img/drop-2.png) - -#### Step3: - -![Add Symbol Texture](./img/drop-3.png) - -#### Step4: Click rebase. - - ---- -### CONFLICT RESOLVE - -:::warning -Any time in this step, if you see many problem and can't resolve conflict. -Click this button to exit what are you doing. And try another way. - -![Add Symbol Texture](./img/resolve-conflic-3.png) - -::: - - -When you meet this warning: - -![Add Symbol Texture](./img/resolve-conflic-1.png) - - - -Step1: Click **Local Change** -Step2: Select version you want -Step3: Click Choose -:::warning -If you have multi file conflict. All files will appear in *Unstaged** -You have to resolve all these files. -::: - -Step3: Click **Continue Rebase** - - -![Add Symbol Texture](./img/resolve-conflic-2.png) - - ---- -### PUSH FAIL - -![Add Symbol Texture](./img/push-fail-1.png) - -If you see this image, It's mean you already push it. - -![Add Symbol Texture](./img/push-fail-2.png) - -**2 ways to fix it ** - -**Rebase to old commit** and resolve conflict to keep all file in old version. - -![Add Symbol Texture](./img/push-fail-4.png) - -**Force Push** to remove old version branch in git & using this branch like newest. - -![Add Symbol Texture](./img/push-fail-3.png) - diff --git a/docs/git-using/02-tip-setup-spin-panel.md b/docs/git-using/02-tip-setup-spin-panel.md deleted file mode 100644 index a95ed51..0000000 --- a/docs/git-using/02-tip-setup-spin-panel.md +++ /dev/null @@ -1,13 +0,0 @@ -# TIP SETUP SPIN PANEL - -Add reel-bg for each reel -Add reel-frame -Setting spacing: layout (reels-frame node) -Find size item: - +Heigh: average item size => 220. Set spin-panel - +Width: size reel-bg = 240 + setting spacing(20) = 260 - -landing-panel -present-win-cell-panel -present-win-border-panel -item-description \ No newline at end of file diff --git a/docs/git-using/03-test special-win.md b/docs/git-using/03-test special-win.md deleted file mode 100644 index 04d0823..0000000 --- a/docs/git-using/03-test special-win.md +++ /dev/null @@ -1,7 +0,0 @@ -# TIP TEST SPECIAL WIN - -You have to test a lot when working on localization. - -By this way, every time you spin will display all special-win. - -![Add Symbol Texture](./img/test-special-win.png) \ No newline at end of file diff --git a/docs/git-using/04-work-flow.md b/docs/git-using/04-work-flow.md deleted file mode 100644 index 46fa9bd..0000000 --- a/docs/git-using/04-work-flow.md +++ /dev/null @@ -1,33 +0,0 @@ -# WORK FLOW - -## Team VN - -_Create Issue: include feature & bug - -_Prepare all assets for that feature & bug. - -_Update documentation. - -## Team Italy - -_Using gitea: drag issue from : ToDo -> In Progress -> Done (Git auto change to done) - -_Support teamVN feedback about documentation. - - -## GIT FLOW - -**Team Italy** after finish any feature or bug. -:::tip -Create PullRequest: Title format should be: `Close #{Issue ID}: {content}` (Following this format will help automate the closing of linked issues when the pull request is merged). -::: - -**Team VN** will try to review and merge as soon as possible. - - -:::tip -Sometimes **team VN** still not merge PullRequest and **team Italy** want to do next issue. -To avoid conflicts, recommend using prefabs for features and notifying team members whenever update the SCENE. - -Normally, if PullRequest1 is good and merge to develop. PullRequest2 will not conflict. -::: \ No newline at end of file diff --git a/docs/git-using/_category_.json b/docs/git-using/_category_.json deleted file mode 100644 index 621f697..0000000 --- a/docs/git-using/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "USING GIT", - "collapsible": true, - "collapsed": false, - "link": { - "title": "USING GIT" - } -} \ No newline at end of file diff --git a/docs/git-using/image.png b/docs/git-using/image.png deleted file mode 100644 index c626a6b..0000000 Binary files a/docs/git-using/image.png and /dev/null differ diff --git a/docs/git-using/img/after.png b/docs/git-using/img/after.png deleted file mode 100644 index 7b06911..0000000 Binary files a/docs/git-using/img/after.png and /dev/null differ diff --git a/docs/git-using/img/amend-1.png b/docs/git-using/img/amend-1.png deleted file mode 100644 index 9b90768..0000000 Binary files a/docs/git-using/img/amend-1.png and /dev/null differ diff --git a/docs/git-using/img/amend-2.png b/docs/git-using/img/amend-2.png deleted file mode 100644 index e21b906..0000000 Binary files a/docs/git-using/img/amend-2.png and /dev/null differ diff --git a/docs/git-using/img/amend-3.png b/docs/git-using/img/amend-3.png deleted file mode 100644 index 5b59228..0000000 Binary files a/docs/git-using/img/amend-3.png and /dev/null differ diff --git a/docs/git-using/img/amend-4.png b/docs/git-using/img/amend-4.png deleted file mode 100644 index ea9988b..0000000 Binary files a/docs/git-using/img/amend-4.png and /dev/null differ diff --git a/docs/git-using/img/amend-5.png b/docs/git-using/img/amend-5.png deleted file mode 100644 index 8077c54..0000000 Binary files a/docs/git-using/img/amend-5.png and /dev/null differ diff --git a/docs/git-using/img/before.png b/docs/git-using/img/before.png deleted file mode 100644 index e32bb53..0000000 Binary files a/docs/git-using/img/before.png and /dev/null differ diff --git a/docs/git-using/img/drop-1.png b/docs/git-using/img/drop-1.png deleted file mode 100644 index c296288..0000000 Binary files a/docs/git-using/img/drop-1.png and /dev/null differ diff --git a/docs/git-using/img/drop-2.png b/docs/git-using/img/drop-2.png deleted file mode 100644 index e40b62a..0000000 Binary files a/docs/git-using/img/drop-2.png and /dev/null differ diff --git a/docs/git-using/img/drop-3.png b/docs/git-using/img/drop-3.png deleted file mode 100644 index 1d31ef3..0000000 Binary files a/docs/git-using/img/drop-3.png and /dev/null differ diff --git a/docs/git-using/img/drop-4.png b/docs/git-using/img/drop-4.png deleted file mode 100644 index 43e30c1..0000000 Binary files a/docs/git-using/img/drop-4.png and /dev/null differ diff --git a/docs/git-using/img/push-fail-1.png b/docs/git-using/img/push-fail-1.png deleted file mode 100644 index 883580a..0000000 Binary files a/docs/git-using/img/push-fail-1.png and /dev/null differ diff --git a/docs/git-using/img/push-fail-2.png b/docs/git-using/img/push-fail-2.png deleted file mode 100644 index aa824a0..0000000 Binary files a/docs/git-using/img/push-fail-2.png and /dev/null differ diff --git a/docs/git-using/img/push-fail-3.png b/docs/git-using/img/push-fail-3.png deleted file mode 100644 index 71e76d1..0000000 Binary files a/docs/git-using/img/push-fail-3.png and /dev/null differ diff --git a/docs/git-using/img/push-fail-4.png b/docs/git-using/img/push-fail-4.png deleted file mode 100644 index 3f1aea6..0000000 Binary files a/docs/git-using/img/push-fail-4.png and /dev/null differ diff --git a/docs/git-using/img/rebase-1.png b/docs/git-using/img/rebase-1.png deleted file mode 100644 index 1e63335..0000000 Binary files a/docs/git-using/img/rebase-1.png and /dev/null differ diff --git a/docs/git-using/img/rebase-2.png b/docs/git-using/img/rebase-2.png deleted file mode 100644 index 4092249..0000000 Binary files a/docs/git-using/img/rebase-2.png and /dev/null differ diff --git a/docs/git-using/img/rebase-3.png b/docs/git-using/img/rebase-3.png deleted file mode 100644 index 4406a28..0000000 Binary files a/docs/git-using/img/rebase-3.png and /dev/null differ diff --git a/docs/git-using/img/resolve-conflic-1.png b/docs/git-using/img/resolve-conflic-1.png deleted file mode 100644 index 1782024..0000000 Binary files a/docs/git-using/img/resolve-conflic-1.png and /dev/null differ diff --git a/docs/git-using/img/resolve-conflic-2.png b/docs/git-using/img/resolve-conflic-2.png deleted file mode 100644 index 56e395e..0000000 Binary files a/docs/git-using/img/resolve-conflic-2.png and /dev/null differ diff --git a/docs/git-using/img/resolve-conflic-3.png b/docs/git-using/img/resolve-conflic-3.png deleted file mode 100644 index d89a67b..0000000 Binary files a/docs/git-using/img/resolve-conflic-3.png and /dev/null differ diff --git a/docs/git-using/img/test-special-win.png b/docs/git-using/img/test-special-win.png deleted file mode 100644 index 817aa25..0000000 Binary files a/docs/git-using/img/test-special-win.png and /dev/null differ diff --git a/docs/git-using/test.md b/docs/git-using/test.md deleted file mode 100644 index 63eb27a..0000000 --- a/docs/git-using/test.md +++ /dev/null @@ -1,19 +0,0 @@ -# MD - - - -| Step | Action | image | -|------|---------|--------------| -| 1. Locate Prefab | Search for `ui-bottom-bar-panel` prefab | ![Locate Prefabs](./img/push-fail-3.png) | -| 2. Find Assets | Navigate to `core/editor` directory | ![Copy UI Folder](./img/push-fail-3.png) | -| 3. Clone Assets | Copy / Paste to game assets location | ![Asset Placement](./img/push-fail-3.png) | - - - -![Add Symbol Texture](./img/rebase-2.png) - - -:::warning -If you missing step 1, this popup will appear. Back to step 1 and do it again. -![Add Symbol Texture](./img/rebase-3.png) -::: \ No newline at end of file