Review sidebar and titles - How to make a game on WAX

wax-office-of-inspector-general · Oct 10, 2024 · 74439ad · 74439ad
1 parent 0e6e7a1
commit 74439ad
Show file tree

Hide file tree

Showing 19 changed files with 108 additions and 38 deletions.
diff --git a/docs/.vitepress/locales/en/components/sidebar.ts b/docs/.vitepress/locales/en/components/sidebar.ts
@@ -157,11 +157,37 @@ export default [
                     {
                         text: 'Tic-Tac-Toe Game',
                         link: '/build/tutorials/tic-tac-toe-game/',
+                        collapsed: true,
                         items: [
                             {text: 'Game Client', link: '/build/tutorials/tic-tac-toe-game/client'},
                             {text: 'Smart Contract', link: '/build/tutorials/tic-tac-toe-game/smart-contract'}
                         ],
                     },
+                    {
+                      text: 'Create Farming Games',
+                      link: '/build/tutorials/howto-create_farming_game/',
+                      collapsed: true,
+                      items: [
+                        {text: 'General Concepts', link: '/build/tutorials/howto-create_farming_game/Part1'},
+                        {text: 'Create a Farmable Object', link: '/build/tutorials/howto-create_farming_game/Part2'},
+                        {text: 'NFT Creation', link: '/build/tutorials/howto-create_farming_game/Part3'},
+                        {text: 'What are Resources', link: '/build/tutorials/howto-create_farming_game/Part4'},
+                        {text: 'NFT Staking', link: '/build/tutorials/howto-create_farming_game/Part5'},
+                        {text: 'Farming Process', link: '/build/tutorials/howto-create_farming_game/Part6'},
+                        {text: 'Creating the GUI', link: '/build/tutorials/howto-create_farming_game/Part7'},
+                        {text: 'Upgrading Items', link: '/build/tutorials/howto-create_farming_game/Part8'},
+                        {text: 'NFT Blends', link: '/build/tutorials/howto-create_farming_game/Part9'},
+                        {text: 'Avatars', link: '/build/tutorials/howto-create_farming_game/Part10'},
+                        {text: 'UI for Blends', link: '/build/tutorials/howto-create_farming_game/Part11'},
+                        {text: 'Token Swaps', link: '/build/tutorials/howto-create_farming_game/Part12'},
+                        {text: 'Token Staking and Voting', link: '/build/tutorials/howto-create_farming_game/Part13'},
+                        {text: 'Governance', link: '/build/tutorials/howto-create_farming_game/Part14'},
+                        {text: 'GUI for Swaps/Staking/Governance', link: '/build/tutorials/howto-create_farming_game/Part15'},
+                        {text: 'Leaderboards', link: '/build/tutorials/howto-create_farming_game/Part16'},
+                        {text: 'Quest System', link: '/build/tutorials/howto-create_farming_game/Part17'},
+                        {text: 'GUI for Quest/Leaderboards', link: '/build/tutorials/howto-create_farming_game/Part18'},
+                      ],
+                    },
                     {
                       text: 'Create/Issue Fungible Tokens',
                       link: '/build/tutorials/create-issue-token/'
@@ -183,6 +209,7 @@ export default [
                     {
                         text: 'SimpleAssets Guide',
                         link: '/build/tutorials/howto_simpleassets/',
+                        collapsed: true,
                         items: [
                             {text: 'Structure', link: '/build/tutorials/howto_simpleassets/nft_basics'},
                             {text: 'Mint NFT', link: '/build/tutorials/howto_simpleassets/nft_use'},
@@ -198,6 +225,7 @@ export default [
                     {
                         text: 'Create RNG Contract',
                         link: '/build/tutorials/create-wax-rng-smart-contract/',
+                        collapsed: true,
                         items: [
                             {text: 'RNG Basics', link: '/build/tutorials/create-wax-rng-smart-contract/rng_basics'},
                             {text: 'Calling RNG Contract', link: '/build/tutorials/create-wax-rng-smart-contract/rng_sample'},
@@ -208,6 +236,7 @@ export default [
                     {
                         text: 'WharfKit',
                         link: '/build/tutorials/wharfkit/',
+                        collapsed: true,
                         items: [
                           {text: 'Wharfkit in React', link: '/build/tutorials/wharfkit/howto_react'},
                           {text: 'Wharfkit Multi-Session', link: '/build/tutorials/wharfkit/multisession'},
@@ -217,7 +246,10 @@ export default [
                         text: 'SS verification',
                         link: '/build/tutorials/server-side-verification/',
                     },
-                    {text: 'How To Explore WAX Blockchain', link: '/build/tutorials/howto_blockexplorer'}
+                    {
+                        text: 'How To Explore WAX Blockchain', 
+                        link: '/build/tutorials/howto_blockexplorer'
+                    }
                 ],
             },
             {

diff --git a/docs/build/tutorials/howto-create_farming_game/Part1.md b/docs/build/tutorials/howto-create_farming_game/Part1.md
@@ -1,5 +1,7 @@
-Part 1. How to make a game on WAX. General concepts.
-====================================================
+---
+title: Part 1. How to create a farming game on WAX. General concepts.
+order: 5
+---
 
 Hey WAX game makers! Ready for a step-by-step guide to building your own game on WAX? Let’s dive in:
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part10.md b/docs/build/tutorials/howto-create_farming_game/Part10.md
@@ -1,5 +1,7 @@
-Part 10: Implementing avatars in WAX games
-==========================================
+---
+title: Part 10. Implementing avatars in WAX games
+order: 50
+---
 
 This article will explore how to create avatars and their equipment, focusing on the customization and personalization aspects that enhance player experience. By detailing the process of designing avatars and selecting their gear, we aim to provide insights into building more engaging and interactive game elements, allowing players to deeply immerse themselves in the game world with characters that reflect their style and preferences. 
 ### 1. Creating categories

diff --git a/docs/build/tutorials/howto-create_farming_game/Part11.md b/docs/build/tutorials/howto-create_farming_game/Part11.md
@@ -1,5 +1,7 @@
-Part 11: UI for Blends, upgrades and avatars
-============================================
+---
+title: Part 11. UI for Blends, upgrades and avatars
+order: 55
+---
 
 Building on our ReactJS and WAX smart contract interaction guide, this article advances our application's development. We'll delve into the intricacies of blends and workspace upgrades, alongside the necessary tools. Additionally, guidance will be provided on interface actions in sync with our smart contract, enhancing the application's functionality and user experience.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part12.md b/docs/build/tutorials/howto-create_farming_game/Part12.md
@@ -1,5 +1,7 @@
-Part 12: Token and resource swaps
-===
+---
+title: Part 12. Token and resource swaps
+order: 60
+---
 
 In this article, we're building on previous discussions about upgrading items by introducing a method to exchange resources for tokens. We'll add a new table to track resources, where each entry includes a `key_id` (numerical ID for the resource), `resource_name`, and a `ratio` defining how many resources convert to one token. For instance, a ratio of 25 means 100 units of wood would exchange for 4 tokens. We'll also integrate the standard `eosio.token` contract, previously covered, to handle these transactions.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part13.md b/docs/build/tutorials/howto-create_farming_game/Part13.md
@@ -1,5 +1,7 @@
-Part 13: Token Staking and Voting in games
-===
+---
+title: Part 13. Token Staking and Voting in games
+order: 65
+---
 
 To delve into token staking and its role in governance, we begin by setting up a new table to manage the staking process. This table will track the staked tokens and their corresponding voting rights, crucial for enabling players to participate in key decision-making processes, such as changing resource-to-token ratios in swaps. This functionality not only deepens player engagement but also decentralizes game governance, empowering players to have a say in the game's economic strategies.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part14.md b/docs/build/tutorials/howto-create_farming_game/Part14.md
@@ -1,5 +1,7 @@
-Part 14: Governance in games
-===
+---
+title: Part 14. Governance in games
+order: 70
+---
 
 In this article, we will develop a voting system that will allow users to provide developers with suggestions or change the value of game changes.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part15.md b/docs/build/tutorials/howto-create_farming_game/Part15.md
@@ -1,5 +1,7 @@
-Part 15: GUI for swaps, staking and governance
-===
+---
+title: Part 15. GUI for swaps, staking and governance
+order: 75
+---
 
 In addition to the previous articles integrating it into a ReactJS interface, and reading data from a WAX smart contract table, we will also dive deeper into swaps. We will look at the use of WAX tokens or NFTs in games and how user/player governance works.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part16.md b/docs/build/tutorials/howto-create_farming_game/Part16.md
@@ -1,5 +1,7 @@
-Part 16: Leaderboards in games
-===
+---
+title: Part 16. Leaderboards in games
+order: 80
+---
 
 In this article, we will analyze the creation of leaderboards and consider the implementation of a leaderboard for user resources and their overall mining rate.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part17.md b/docs/build/tutorials/howto-create_farming_game/Part17.md
@@ -1,5 +1,7 @@
-Part 17: Quest systems in game
-===
+---
+title: Part 17. Quest systems in game
+order: 85
+---
 
 In this article, we will add a quest system that will allow us to engage more with the players in our games.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part18.md b/docs/build/tutorials/howto-create_farming_game/Part18.md
@@ -1,11 +1,13 @@
-Part 18: GUI for quests and leaderboards
-===
+---
+title: Part 18. GUI for quests and leaderboards
+order: 90
+---
 
 In our previous article, we looked at swaps, token stakes, and governance mechanisms.
 
 Building on that foundation, in this article we will also explore leaderboard functionality and delve into quests in the context of the game ecosystem.
 
-**Leaderboard**s
+**Leaderboard**
 ----------------
 
 A leaderboard is essential for tracking and displaying the performance and progress of participants in a gaming environment. It serves as a visual representation of rankings, motivating players to strive for higher positions and encouraging healthy competition.

diff --git a/docs/build/tutorials/howto-create_farming_game/Part2.md b/docs/build/tutorials/howto-create_farming_game/Part2.md
@@ -1,5 +1,7 @@
-Part 2. Creating a farmable object or item in AtomicAssets standard.
-====================================================================
+---
+title: Part 2. Creating a farmable object or item in AtomicAssets standard.
+order: 10
+---
 
 This is next article regarding game creation series, you can follow first [introduction one](https://dapplica.io/blog/wax/part-1-how-to-make-a-game-on-wax-general-concepts) if you didn’t read it yet.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part3.md b/docs/build/tutorials/howto-create_farming_game/Part3.md
@@ -1,5 +1,8 @@
-Part 3. Farming NFT creation on Atomic Hub
-==========================================
+---
+title: Part 3. Farming NFT creation on Atomic Hub
+order: 15
+---
+
 In our last article, we walked you through creating a collection and item. Now, let's step up the game and focus on crafting a farming item.
 
 ### 3.1 Creating a Category (Scheme) for NFTs

diff --git a/docs/build/tutorials/howto-create_farming_game/Part4.md b/docs/build/tutorials/howto-create_farming_game/Part4.md
@@ -1,5 +1,8 @@
-Part 4. What are resources and tokens in our game creation process.
-===================================================================
+---
+title: Part 4. What are resources and tokens in our game creation process.
+order: 20
+---
+
 In this article, we're diving into two game-changers: resources and tokens.
 
 First up, resources. Think of them as the nuts and bolts of your game's economy. They're the materials and items players mine, produce, or nab during gameplay. Each resource comes with its own flavor -- rarity, crafting abilities, and ways to interact within the game.

diff --git a/docs/build/tutorials/howto-create_farming_game/Part5.md b/docs/build/tutorials/howto-create_farming_game/Part5.md
@@ -1,5 +1,7 @@
-Part 5. NFT Staking
-===================
+---
+title: Part 5. NFT Staking
+order: 25
+---
 
 Today, we're diving into staking NFTs in our game's smart contract. This strategy helps manage market prices by locking NFTs in the contract. Imagine setting an unstaking period of 3 to 30 days for added control.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part6.md b/docs/build/tutorials/howto-create_farming_game/Part6.md
@@ -1,5 +1,7 @@
-Part 6. Types of Farming and farming process
-============================================
+---
+title: Part 6. Types of Farming and farming process
+order: 30
+---
 
 In this article, we'll break down the resource farming process. Building on the staking code from our previous article, we'll introduce additional tables and functions specific to resource farming.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part7.md b/docs/build/tutorials/howto-create_farming_game/Part7.md
@@ -1,5 +1,7 @@
-Part 7: Creating GUI for WAX game, staking and farming
-======================================================
+---
+title: Part 7. Creating GUI for WAX game, staking and farming
+order: 35
+---
 
 This article will walk you through connecting a wallet to the WAX blockchain, integrating it into a ReactJS interface, and reading data from a WAX smart contract table. We'll also cover the NFT staking process and how to claim rewards.  
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part8.md b/docs/build/tutorials/howto-create_farming_game/Part8.md
@@ -1,5 +1,7 @@
-Part 8: Upgrades of game items in WAX games
-===========================================
+---
+title: Part 8. Upgrades of game items in WAX games
+order: 40
+---
 
 In previous articles, we explored how to farm resources using our NFT. Now, we'll delve into upgrading items for more efficient resource mining. Upgrading items involves enhancing their capabilities, making them more effective at mining resources. This process is key to progressing and achieving higher efficiency in the game. We'll start by adding the necessary code to implement item upgrades, focusing on improving the performance of our NFTs for resource collection.
 

diff --git a/docs/build/tutorials/howto-create_farming_game/Part9.md b/docs/build/tutorials/howto-create_farming_game/Part9.md
@@ -1,5 +1,7 @@
-Part 9: Blends of NFTs for WAX games
-====================================
+---
+title: Part 9. Blends of NFTs for WAX games
+order: 45
+---
 
 In this article, following our previous one  on upgrading farming items, we're diving into creating blends. Blending involves combining specific items to create new or enhanced ones within the game. This feature adds depth and strategy to the game, offering players the opportunity to craft unique items with potentially higher value or utility.