Game Zone Add-On Detailed Documentation

Introduction

The Game Zone Add-On is a comprehensive management system designed to help administrators oversee all aspects of a gaming facility from a single platform. It covers the full operational workflow, from configuring game zones and managing the game library to handling player registrations, game rentals, membership plans, and food orders. The Add-On also includes a dedicated payments module to track and manage all financial transactions. Each section is built to work in connection with the others, ensuring that data such as zones, games, players, and benefits flows consistently across the platform.

How To Install the Add-On?

To Set Up the Game Zone Add-On, you can follow this link: Setup Add-On

How To Use the Game Zone Add-On?

System Setup

• The System Setup section allows administrators to configure foundational data used across the system. It currently includes Game Zones and Game Benefits, which are referenced when managing gaming areas and membership perks throughout the platform.

Manage Games

• To add a new game, click the “Create” button on the Manage Games page. Enter the Game Name in the provided field. Optionally, enter the Genre to categorize the game by its play style. Select a Release Date using the date picker.
• Add a Description to provide additional context about the game. Enter the Price in euros to define the cost associated with the game. Set the Status using the dropdown to mark the game as Active or Inactive.
• Enter the Max Players value to define the maximum number of players supported. Finally, select the Zone from the dropdown to assign the game to the appropriate area within the facility.
• The list page displays all games in a table with columns for Game Name, Genre, Price, Status, and Zone Name. Use the Search bar to quickly locate a specific game by name.
• Toggle between list view and grid view using the view buttons at the top right. Apply filters using the Game Zone dropdown and the Status dropdown to narrow down results. Click Apply to activate the filters or Clear to reset them.
• In the Actions column, use View to inspect the full details of a game record, Edit to update or modify an existing game’s information, and Delete to permanently remove the game from the system.
• 

Game Players

• To add a new game player, click the “Create” button on the Manage Game Players page. Enter the player’s First Name and Last Name in the provided fields. Enter the Email address and Mobile Number. Enter the player’s Age and optionally, provide an Address.
• The list page displays all game players in a table with columns for First Name, Last Name, Email, Mobile Number, and Age. Use the Search bar to quickly locate a specific player by name. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, use View to inspect the full details of a player’s record, Edit to update or modify an existing player’s information, and Delete to permanently remove the player from the system.
• 

Game Rentals

• To create a new game rental, click the “Create” button on the Manage Game Rentals page. Enter the renter’s Name, Email, and Mobile Number. Select a Rental Date using the date picker, then set the Start Time and End Time for the rental session.
• Enter the Rent Price in euros. Select a Bank Account from the dropdown to associate the payment. Choose the Game from the dropdown (which comes from the game section) and choose Zone from the dropdown (which comes from the game zone > system setup), then select the Player from the dropdown, to assign the rental to the appropriate game player.
• The list page displays all game rentals in a table with columns for Name, Game Name, Player Name, Rental Date, Rent Price, Status, and Payment Status. The Status column reflects whether the rental is currently Rented or Returned. The Payment Status column indicates whether the rental is Paid or Draft.
• Use the Search bar to quickly locate a specific rental record. Apply filters using the Game, Player, Status, and Payment Status dropdowns to narrow down results. Click Apply to activate the filters or Clear to reset them. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, available actions vary depending on the rental’s payment status. For Draft rentals, use Invoice to generate a rental invoice, Return to mark the game as returned, View to inspect the full rental details, Edit to update or modify the rental information, and Delete to permanently remove the rental record.
• For Paid rentals with a Rented status, use Post to confirm and post the rental record, and View to inspect its details. For fully Returned and Paid rentals, only View is available. Note that rental records actively tied to payments should be managed carefully, as changes may affect financial records that reference them.
• 

Membership Plans

• To create a new membership plan, click the “Create” button on the Manage Membership Plans page. Enter the plan Name in the provided field. Set the Monthly Price and Yearly Price in euros to define the subscription rates for each billing cycle.
• Select the Benefits from the dropdown to include the perks associated with this plan. Select the Games from the dropdown to specify which games are accessible under the plan.
• Optionally, add a Description to provide additional context about the plan. Set the Status using the dropdown to mark the plan as Active or Inactive. Finally, select the Zone from the dropdown to assign the plan to the appropriate game zone within the facility.
• The list page displays all membership plans in a table with columns for Name, Monthly Price, Yearly Price, Zone Name, and Status. The Status column reflects whether a plan is currently active and available for member enrollment.
• Use the Search bar to quickly locate a specific membership plan by name. Apply filters using the Zone and Status dropdowns to narrow down results. Click Apply to activate the filters or Clear to reset them. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, use View to inspect the full details of a membership plan, Edit to update or modify an existing plan’s information, and Delete to permanently remove the plan from the system.
• 

Manage Memberships

• To create a new membership, click the “Create” button on the Manage Memberships page. Enter the membership Name in the provided field. Select a Membership Plan from the dropdown to assign the appropriate plan to this membership. Choose the Membership Type using the radio buttons; select Monthly for a one-month membership or Yearly for an annual membership.
• The Price field will auto-populate based on the selected plan and membership type. Select a Start Date using the date picker, and the End Date will be automatically calculated based on the membership type.
• Optionally, select a Player from the dropdown to assign the membership to a specific game player. Add a Description to provide any additional context or notes about the membership.
• The list page displays all memberships in a table with columns for Name, Membership Type, Price, Start Date, End Date, Status, Membership Plan, Player Name, and Payment Status.
• The Status column reflects whether a membership is currently Active, Suspended, Expired, or Cancelled. End dates highlighted in red indicate that the membership has already lapsed. Administrators can update the status of a membership directly from the list using the dropdown on each record.
• Use the Search bar to quickly locate a specific membership by name. Apply filters using the Membership Type and Status dropdowns to narrow down results. Click Apply to activate the filters or Clear to reset them. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, available actions vary depending on the membership’s payment status. For memberships with a Pending payment status, use the Invoice option to generate a payment, View to inspect the full membership details, Edit to update or modify the membership information, and Delete to permanently remove the record.
• For memberships with a Cancelled payment status, the Invoice icon and View action are available. For fully Paid memberships, only View is available.
• When recording a payment, the payment form will auto-fill the Payment Amount, Membership, and Player Name fields. Select the Payment Date, choose a Bank Account from the dropdown, enter a Reference Number, and optionally add a Description before submitting. Note that once a payment is made, the membership record can no longer be edited or deleted.
• 

Manage Payments

• The list page displays all membership payments in a table with columns for Reference Number, Membership, Player, Amount, Payment Date, and Status. The Status column reflects whether a payment is Pending, Cleared, or Cancelled.
• Use the Search bar to quickly locate a specific payment by Reference Number or Player Name. Apply filters using the Status dropdown and the Payment Date Range picker to narrow down results. Click Apply to activate the filters or Clear to reset them.
• In the Actions column, available actions vary depending on the payment’s status. For Pending payments, use Mark as Cleared to confirm that the payment has been successfully received, Cancel Payment to void the transaction, View to inspect the full payment details, and Delete to permanently remove the payment record.
• For Cleared and Cancelled payments, only View is available. Note that payments marked as Cleared or Cancelled can no longer be modified or deleted, as changes may affect membership records that reference them.
• 

Manage Foods

• To add a new food item, click the “Create” button on the Manage Foods page. Enter the Food Name in the provided field. Select the Food Type from the dropdown to categorize the item as Snacks, Meals, Beverages, Desserts, or other available types. Enter the Price in euros. Set the Status using the dropdown to mark the item as Available or Unavailable.
• Optionally, upload a Food Image by clicking Browse to select an image file. Add a Description to provide additional context about the item. Finally, select the Zone from the dropdown to assign the food item to the appropriate game zone within the facility.
• The list page displays all food items in a table with columns for Food Name, Food Type, Price, Status, and Zone Name. The Status column reflects whether a food item is currently Available or Unavailable for ordering.
• Use the Search bar to quickly locate a specific food item by name. Apply filters using the Food Type and Status dropdowns to narrow down results. Click Apply to activate the filters or Clear to reset them. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, use View to inspect the full details of a food item, Edit to update or modify an existing item’s information, and Delete to permanently remove the food item from the system.
• 

Manage Food Orders

• To create a new food order, click the “Create” button on the Manage Food Orders page. The creation form is divided into two sections: Order Details and Order Items.
• In the Order Details section, select the Order Date using the date picker. Optionally, select a Player from the dropdown to assign the order to a specific game player. Select the Zone to associate the order with the appropriate game zone.
• Choose a Bank Account from the dropdown to link the payment. Enter the Payment Method and optionally add an Extra Charge in euros if applicable. Add any Special Notes to include specific instructions or requests for the order.
• In the Order Items section, select a Food Item from the dropdown, set the Qty, and enter the Price. The Total for each line item will calculate automatically. Click “+ Add Item” to include additional food items in the order. The Order Summary at the bottom displays the Subtotal and Total Amount, updating in real time as items are added.
• The list page displays all food orders in a table with columns for Order Number, Order Date, Total Price, Player Name, Zone Name, Status, and Payment Status. The Status column reflects the current stage of the order, which may be Pending, Confirmed, Preparing, Ready, Delivered, or Cancelled. The Payment Status column indicates whether the order is Draft or Paid. Administrators can update the status of an order directly from the list using the dropdown on each record.
• Use the Search bar to quickly locate a specific order by name or reference. Apply filters using the Payment Status and Status dropdowns to narrow down results. Click Apply to activate the filters or Clear to reset them. Toggle between list view and grid view using the view buttons at the top right.
• In the Actions column, available actions vary depending on the order’s payment status. For Draft orders, use the Download icon to export the order, Invoice to generate an order invoice, View to inspect the full order details, Edit to update or modify the order, and Delete to permanently remove it.
• For Paid orders with a Delivered or Ready status, use Download and View. For Paid orders still in progress, use Post to confirm and finalize the order record alongside Download and View.
•