diff --git a/docs/02-setup-main-game/05-main-scene/07-item-description.md b/docs/02-setup-main-game/05-main-scene/07-item-description.md index e08ea93..f2ef36a 100644 --- a/docs/02-setup-main-game/05-main-scene/07-item-description.md +++ b/docs/02-setup-main-game/05-main-scene/07-item-description.md @@ -4,8 +4,73 @@ sidebar_position: 7 # Item Description -> To be Add +Provides players with detailed information about each item in the game. + --- -> To be Add \ No newline at end of file +## Overview + +![Item Description Overview](./img/07-item-description/overview.png) + +## Prepare the assets +| Assets | Description | +|--------|-------------| +| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-1.png) | Used to Setup the background. | +| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-2.png) | Used to Setup the static symbol. | +| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-3.png) | Used to Setup the animation symbol. | +| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-4.png) | Used to Setup the payout/description. | + +## Setup Prefabs Item Description + +| Step | Action | Description | Image Reference | +| :--: | :----- | :---------- | :-------------: | +| 1 | Locate all template prefabs needed for the **Item Description** | Search for the `template-item-description` prefab. | ![Locate Prefabs](./img/07-item-description/prepare-prefabs-1.png) | +| 2 | Clone assets| Copy and paste them to the game assets location, then rename the copied prefabs by removing unnecessary prefixes. | ![Locate Prefabs](./img/07-item-description/prepare-prefabs-2.png) | + +### item-description-small + + Setup the `item-description-small` prefab for items have a win payout: + + ![Locate Prefabs](./img/07-item-description/setup-item-small-overview.png) + + | Step | Action | Image Reference | + | :--: | :----- | :-------------: | + | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-small-1.png) | + | 2 | - Name the item prefab following the format item-description-**name**".
- Setup the **Animation Name** to match the item's name in the **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-small-2.png) | + | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-small-3.png) | + | 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.| ![Locate Prefabs](./img/07-item-description/setup-item-small-4.png) | + + +### item-description-no-odds + Setup the `item-description-no-odds` prefab for items that have a description but no win payout: + + ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-overview.png) + + | Step | Action | Image Reference | + | :--: | :----- | :-------------: | + | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-1.png) | + | 2 | - Name the item prefab following the format item-description-**name**".
- Setup **Animation Name** to match the item's name in the **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-2.png) | + | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-3.png) | + | 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. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-4.png) | + +### item-description-big + Setup the `item-description-big` prefab for items that include both a win payout and a description: + + ![Locate Prefabs](./img/07-item-description/setup-item-big-overview.png) + + | Step | Action | Image Reference | + | :--: | :----- | :-------------: | + | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-big-1.png) | + | 2 | - Setup the payout by following **Step 4** in **Setup prefab `item-description-small`** | [Configure Item Description Small](./item-description#item-description-small) | | + | 3 | - Setup the description by following **Step 4** in **Setup prefab `item-description-no-odds`** | [Configure Item Description No Odds](./item-description#item-description-no-odds) | | + +:::tip + Use Helper to setup: + 1. Setup **Content Size** and **Cell Item Size** according to the game design. + 2. Use prepared bitmap fonts to Setup the **Labels** font. + 3. Click **Set Size** to run the helper. + 4. Setup the **Background**, **Sprite Frame**, **Animation**, **Payout**, **Description** of the item using the prepared assets. + + ![Locate Prefabs](./img/07-item-description/setup-item-helper.png) +::: \ No newline at end of file diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/overview.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/overview.png new file mode 100644 index 0000000..e44c3f3 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/overview.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-1.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-1.png new file mode 100644 index 0000000..a96fef2 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-1.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-2.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-2.png new file mode 100644 index 0000000..84510b8 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-2.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-3.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-3.png new file mode 100644 index 0000000..9f7a795 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-3.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-4.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-4.png new file mode 100644 index 0000000..3c999cf Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-assets-4.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-1.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-1.png new file mode 100644 index 0000000..8782c12 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-1.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-2.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-2.png new file mode 100644 index 0000000..f38a5f7 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/prepare-prefabs-2.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-1.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-1.png new file mode 100644 index 0000000..de2c3a5 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-1.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-overview.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-overview.png new file mode 100644 index 0000000..faf0703 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-big-overview.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-helper.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-helper.png new file mode 100644 index 0000000..7321faf Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-helper.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-1.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-1.png new file mode 100644 index 0000000..15c4f88 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-1.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-2.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-2.png new file mode 100644 index 0000000..0b1ff14 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-2.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-3.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-3.png new file mode 100644 index 0000000..aa70b95 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-3.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-4.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-4.png new file mode 100644 index 0000000..991da33 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-4.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-overview.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-overview.png new file mode 100644 index 0000000..2fe8138 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-no-odds-overview.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-1.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-1.png new file mode 100644 index 0000000..86278ce Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-1.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2.png new file mode 100644 index 0000000..cb9331b Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2222.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2222.png new file mode 100644 index 0000000..4fa4b73 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-2222.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-3.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-3.png new file mode 100644 index 0000000..c44e17c Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-3.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-4.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-4.png new file mode 100644 index 0000000..b432373 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-4.png differ diff --git a/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-overview.png b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-overview.png new file mode 100644 index 0000000..f703568 Binary files /dev/null and b/docs/02-setup-main-game/05-main-scene/img/07-item-description/setup-item-small-overview.png differ