Getting Started

1. Prerequisite

   The following Packages are required for the example game to work. Please install them from the package manager if they are not already installed.

   • Post Processing - "com.unity.postprocessing": "3.2.2" - You can get this from the package manager.
   • TextMeshPro - "com.unity.textmeshpro": "3.0.6", The importer window should already be open. Just click Import TMP Essentials.
   
   
2. 1: Open the ExampleScene.unity from Assets/RFI.Freemium/Example/ in Unity
3. 2: Play around with the Example game. It shows off most of the features of the Freemium Starter Kit.
4. 3: Open the Example version of the editor from the Unity Menu at Window > Freemium Starter Kit > Demo > Example Editor

       It is important to open the Example Editor as the main editor will force you to go through the setup(we will get to that later)

5. 4: Go through the Example Editor screens and see what all you can do. In the editor you will see links to YouTube videos describing each screen. Also hovering your mouse over the little question marks will give you a brief explanation of a given control.
6. 5: Read the Example Code Notes from the menu on the left, to get a better understanding of what you will find in the code.
7. 6: Look through the source code and see how the example game is created.
8. 7: Now you are ready to go through the One-Time Setup and begin adding the Freemium Starter Kit to your game.

Note:

It is important to note that the Freemium Starter Kit is a large complex system. It is designed to save mobile game developers a lot of time and effort, but it is by no means a plug and play product. You will need to read the documentation, watch the videos, and write some code to get everything working.

One-Time Setup Instructions

Initial File and Folder Creation

1. Open the FSK Editor window from the Unity Menu at Window > Freemium Starter Kit > Open Editor
2. The FSK Editor will open to the One-Time Setup screen which will walk you through the setup process.
3. The first thing you need to do is click the File Setup button on that screen to automatically create a couple of new files and folders in your project.
4. After clicking, there will be a brief pause while Unity compiles the new scripts.
5. The screen will refresh automatically once the compile is complete. Please wait until the screen refreshes.

Manual Steps

Setting Up Your Scene

1. In your project, open your starting scene or create a new scene and set it as the starting scene.
2. With the scene open, right-click inside the Hierarchy tab to bring up the popup menu.
3. Near the bottom of the menu, you should see an option that says Freemium Starter Kit .
4. Select Freemium Starter Kit then One-Time Setup.

That's it! You are done with the One-Time Setup. Click the Next Step button at the bottom of the editor screen to continue.

Screen Builder

The Freemium Starter Kit introduces a unique approach to UI management, centralizing each UI screen into a standalone prefab and script. This design allows for individual UI screens to be managed as cohesive units. Unlike the typical Unity workflow, where scripts referencing UI elements are attached to objects within the prefab, the scripts actively load and manage the prefab itself. This method might seem unconventional at first, but its simplicity and power are likely to impress once familiar.

To ease the transition to this new approach, the Screen Builder tool has been provided.

Using the Screen Builder

The Screen Builder facilitates the creation of UI prefabs and the automatic generation of base UI scripts. Follow these steps to get started:

1. Launch Screen Builder: Open the Screen Builder UI within the Freemium Editor.
2. Configure Settings : Specify the storage locations for your prefabs and scripts. You can accept the default settings or customize them to your preference.
3. Build the UI Screen :
   1. Step 1 : Name your screen and click the 'Create' button to generate a new base prefab.
   2. Step 2 : Click the 'Open Editor' button to edit the prefab in the Unity scene editor. Now you can add UI components like buttons, sliders, and toggles directly to the scene, like you normally would. However, there are a few exceptions:
      • Exception 1 : It's not necessary to attach scripts to UI elements. Scripts can be added for animations or effects if desired, but they will not be needed for things like button clicks.
      • Exception 2 : The naming of controls is crucial for the Screen Builder to generate a functional script. By default, it creates references for any Button, Toggle, Slider, or ScrollRect included in the prefab. For Text and Image components, references are generated only if their names are prefixed with "ref_", which is the default setting but can be modified in the UI. All TextMeshProUI and Image components with the "ref_" prefix will automatically have references in the script.
      • Exception 2.5 : To automatically link a TextMeshProGUI component to a key stat, enabling it to display the current value of that stat while the UI screen is active, include one of the following key phrases in its name:
        • statcoin: Displays the current coin count.
        • stathealth: Shows the current health level.
        • statenergy: Indicates the current energy level.
        • statkey: Shows the number of keys.
        • statstar: Displays the current star count.
        • statspin: Indicates the number of spins.
        • statgem: Shows the current gem count.
        • stattimelife: Displays the remaining time for health regeneration.
        • stattimeenergy: Shows the remaining time for energy regeneration.
        • statlivesof : Displays the current health as a ratio of the maximum (e.g., 4 of 5).
   3. Step 3 : Select the UI Prefab. This may already be done of you didn't close the Editor window, but if you did just select the UI Prefab that you created. Unselect any UI Control types that you want to ignore and then generate your script.
4. At this point the script file will be in the Code Path that you configured in the Settings and it will be named the same as your Screen Name with a .cs extension.

This streamlined process not only simplifies UI development but also enhances the flexibility and scalability of your UI designs.

Screen Object API Details

Overview

In the Freemium Starter Kit each UI screen is controlled by a new script object inherited from ScreenBase or StatScreen. These objects are responsible for loading, managing, and displaying the UI prefab. Each screen object gives you (the developer) a ton of properties, methods, and events to make managing the UI a simple and easy yet powerful process. All of the properties, methods, and events are listed here, but you should refer to Assets/RFI.Freemium/Example/Scripts/Screens/DemoEventExplanation.cs for more details on the events and explanations on how to use them.

The methods and events described below provide a structured approach to managing the lifecycle of a screen within an application, offering hooks for initialization, regular updates, pausing, resuming, and cleanup.

Class: ScreenBase

Fields

• _IsDying: A bool field that sets whether the UI container is dying or not.
• _IsPaused: A bool field that sets whether the UI container is paused or not.
• _IsClosing: A bool field that shows if the UI container is closing.
• _IsClosed: A bool field that shows if the UI container is closed.
• _IsLoaded: A bool field to check if the UI container is loaded.
• _IsLoading: A bool field to check if the UI container is currently loading.
• _IsVisible : A bool field that indicates if the UI container is currently visible or not.
• _IsShown: A bool field to check if the UI container is shown.
• _ScreenObject : Reference to Unity GameObject container that holds all of the components for the screen.
• _PrefabName: Reference to the name of the UI Prefab that is shown for this screen.
• _ScreenPrefab : Reference to the UI Prefab that is shown for this screen. A Prefab is required for every screen. You can also use the LoadPrefab function to create references to other prefabs as needed. _ScreenPrefab allows you to easily get references to the UI controls inside the UI Prefab. After the screen's class constructor is finished it will be available at any time. However: It is important to note that the following functions for _ScreenPrefab should primarily be used inside the ConstructGUI event where their results are cached. Outside of the ConstructGUI event Unity will have to reload the controls from the Prefab with each call.
• Function details:
  • GetButton: function that retrieves a reference to a Unity Button by its name.
  • GetTextMeshPro : function that retrieves a reference to a TextMeshProUGUI by its name.
  • GetTransform : function that retrieves a reference to a Transform component by its name.
  • GetImage: function that retrieves a reference to an Image component by its name.
  • GetSlider: function that retrieves a reference to a Slider component by its name.
  • GetToggle: function that retrieves a reference to a Toggle component by its name.
• _GlobalManager : Reference to the GlobalManager that is automatically available on every screen.

Methods

• LoadPrefab : Used to fully load and initialize a UI prefab other than the main UI for this screen. This will return an object just like _ScreenPrefab.
• CreateTimer : This method is used to create a timer callback that fires at a given interval.
• CloseAction : This method allows to leave a screen through different ways identified by flags. Internally it fires OnCloseAction() method where flag indicating the closing screen can be evaluated.
• AddControl: Adds a control to the UI manager.
• PreLoad : Can be used to load prefabs so that you can access sub components while constructing the GUI

Events

• OnInit : Called once after the screen is created but before it is shown. This is the place to initialize any components or data.
• ConstructGUI : This is where you should load and set up your GUI. Here you should load your screen prefab and attach all your references. The ScreenBuilder Utility will do a great deal of this work for you.
• OnShow : Called every time the screen is shown to the user. Use this method to refresh data or update the UI.
• OnHide : Called every time the screen is hidden. This is used primarily in dialogs as they are often hidden and reused. This can be used for cleanup activities that are specific to the screen being hidden but not destroyed.
• OnClose: Invoked when the screen is closing. Note that OnClose is not called if AutoDestroy is used(see the "pop" methods in Screen Manager ). For cleanup, consider using OnDispose.
• OnUpdate: Functions similarly to the Unity Update method, called once per frame. Use this for regular updates such as checking for input or updating the UI.
• OnPause : Called when the update process is paused, typically because something else has gained focus or the application is transitioning to a different state.
• OnResume : Invoked when the paused update process resumes, indicating that the screen or application is back in focus.
• OnDispose: This is the final cleanup for the screen, called after OnClose . Use this for thorough cleanup activities.
• OnFocusedGained : Called when the screen gains focus, useful for scenarios where multiple screens or components may be interacting.
• OnFocusedLost : Invoked when the screen loses focus, allowing for adjustments or pausing of activities that require focus.
• OnOneSecondUpdate : A built-in timer method that fires off once every second. Use this for activities that need to happen on a regular but non-frame rate dependent schedule.

Stat Screen Object API Details

Overview

StatScreenBase is an abstract class derived from ScreenBase so it will have all of the features of ScreenBase plus the following:

Class: StatScreenBase

Fields

• _DisplayCoins : Displays the number of coins. Automatically updates when the coin count changes.
• _DisplayGems : Displays the number of gems. Automatically updates when the gem count changes.
• _DisplayLives : Displays the number of lives. Automatically updates when the life count changes.
• _DisplayEnergy : Displays the amount of energy. Automatically updates when the energy level changes.
• _DisplayKeys : Displays the number of keys. Automatically updates when the key count changes.
• _DisplaySpins : Displays the number of spins. Automatically updates when the spin count changes.
• _DisplayStars : Displays the number of stars. Automatically updates when the star count changes.
• _DisplayTimeNextLife : Displays the time until the next life is earned. Updates every second when lives are below the maximum.
• _DisplayTimeNextEnergy : Displays the time until the next energy unit is earned. Updates every second when energy is below the maximum.
• _DisplayLivesOf : Displays the current number of lives in relation to the maximum (e.g., "5 / 6").

Usage

To use the StatScreenBase class, create a subclass that inherits from it. In the ConstructGUI() event assign a TextMeshProUGUI UI object from prefab to the respective stat types they should display. In the following example the TextMeshProUGUI UI object called "EnergyAmountText" will always display the current energy level while this screen is displayed.

Screen Manager API Details

Screens in the Freemium Starter Kit are stored in a FILO stack where the last screen added is always the current active screen. When you add (push) a new screen it will automatically become the current, active screen. When you remove (pop) the current screen the previous screen will automatically become active. The Screen Manager class which is referenced by _GlobalManager.Screen from inside a given screen will help you manage the UI. See the methods below for what options you have.

Methods

void CloseScreen()

Summary: Closes the topmost screen on the stack. This method will cause the screens OnClose event to fire.

void PopAll()

Summary: Removes all screens from the stack.

• Note: This will AutoDestroy the screens, bypassing the OnClose event, but OnDispose will still fire.

void PopScreen()

Summary: Removes the top screen from the stack.

• Note: This will AutoDestroy the screens, bypassing the OnClose event, but OnDispose will still fire.

void PopScreens(int count)

Parameters:

• count: The number of screens to remove from the stack.

Summary: Removes a given number of screens from the stack.

• Note: This will AutoDestroy the screen, bypassing the OnClose event, but OnDispose will still fire.

void PopThisThenPushScreen(ScreenBase newscreen, string sceneName = "")

Parameters:

• newscreen: New screen instance to push onto the stack.
• sceneName: (Optional) Name of the Unity scene to load.

Summary: Removes the top screen from the stack and replaces it with a new screen.

• Note: This will AutoDestroy the screens, bypassing the OnClose event, but OnDispose will still fire.

void PopAllThenPushScreen(ScreenBase newscreen, string sceneName = "")

Parameters:

• newscreen: New screen instance to push onto the stack.
• sceneName: (Optional) Name of the Unity scene to load.

Summary: Clears the stack and pushes a new screen onto it.

• Note: This will AutoDestroy the screens, bypassing the OnClose event, but OnDispose will still fire.

void PushScreen(ScreenBase newscreen, string sceneName = "", bool hidePrevious = false)

Parameters:

• newscreen: New screen instance to push onto the stack.
• sceneName: (Optional) Name of the Unity scene to load.
• hidePrevious: Whether to hide the previous screen instead of graying it out.

Summary: Pushes a new screen onto the stack.

void TimedFadeUIOnly(float duration, Color color, FadeType fadeType)

Parameters:

• duration: Duration of the fade animation.
• color: Color to fade to.
• fadeType: Type of fade to use.

Summary: Performs a fade out and back without loading a new scene.

void HideAll()

Summary: Hides all visible screens.

void ShowAll()

Summary: Shows all previously visible screens.

void AddDialog(DialogBase dialog)

Summary: Adds a new dialog window to the dialog stack.

Parameters:

• dialog: The new dialog instance to push onto the stack.

DialogBase GetDialog(string name)

Summary: Retrieves a specific dialog from the list.

Parameters:

• name: The name of the dialog instance to find.

Returns: The DialogBase instance associated with the specified name. If no dialog with the given name is found, returns null.

List<DialogBase> GetActiveDialogs()

Summary: Gets a list of all active dialogs.

Returns: A List<DialogBase> containing all active dialog instances. If there are no active dialogs, returns an empty list.

Game Manager

In addition to managing the screens you may also want to manage some aspects of the game. The Game Manager class which is referenced by _GlobalManager.Game from inside a given screen will help you manage the game. See the methods below for what options you have.

Methods

void ExitGame()

Summary: Closes all screens and exits the game.

void LoadUnityScene(string sceneName, float duration, Color color, FadeType fadeType)

Parameters:

• sceneName: Name of the scene to load.
• duration: Duration of the fade animation.
• color: Color to fade to.
• fadeType: Type of fade to use.

Summary: Tells Unity to load a new scene with specified parameters.

void UnloadCurrentScene()

Summary: Tells Unity to remove the current scene.

Properties

string GameName { get; }

Summary: Gets the name of the game.

string GameDescription { get; }

Summary: Gets the description of the game.

Game Settings

Support Options

These fields are optional and help link to external support from within your game. Google and Apple require a Privacy Policy and Support URL on app pages. These must be set up regardless.

In-App Review

Using In-App Review will allow you to open a platform-specific review dialog for your game. What I usually do is ask the player what they intend to rate the app. If they say 3 stars or less, I open a pre-filled support email. If you want to change the required minimum rating, the Rating Threshold slider will allow you to set the number of stars required to get the email popup. The Freemium Starter Kit will do all this for you with one API call. Note: To use this feature, you must download and install the Google Play In-App Review plugin for Unity. If you turn on the Allow In-App Review checkbox without installing the plugin, you will get compile errors.

Startup Values

Here you have the option to give the player coins, gems, or keys right from the start.

Health Options

This manages the player's health. In the game, you can call it health, life, hearts, or whatever suits your needs, but in the API it is called Health. If you choose to track health, then used in combination with other settings, you can automatically subtract from a player’s health when they fail a level and prevent them from playing when they have no health left. Health can automatically regenerate over time and you can easily modify the Max Health and Regeneration rates with inventory items. Consumable inventory items can refill or drain Health as you desire.

Energy Options

This manages the player’s energy much like the Health Options above. If you are only using one of the two, you are free to choose between life and energy as they are pretty much the same. I use both. I use Health to control the player’s moving on to new levels before they are ready. I use Energy as a cost for replaying previous levels. Mostly just to control farming and to give the player another stat to manage. Like Health, Energy can automatically regenerate over time and you can easily modify the Max Energy and Regeneration rates with inventory items. Consumable inventory items can refill or drain Energy as you desire.

Stars

Stars can track a player's progress. They are awarded for completing a level. Additionally, during level creation, you can specify how many stars are required for players to access a level. This allows for customizable progression through the game.

Editor Settings

These settings are only for game development and do not impact gameplay. The "Target Width and Height" option informs the editor of the screen resolution for which your UI graphics are designed. When using the Screen Builder, you'll see a purple box that outlines the targeted screen area before scaling. Ensuring your UI elements stay within this purple box guarantees visibility across all device resolutions. In the game, the UI is first rendered to a UI Camera and then overlaid onto the main camera. This UI Camera is visible within the scene editor while the game is running. If you need to adjust the scene while the game is active, you can use the "Camera Offset" to reposition the UI Camera. I typically do this to keep it out of the way.

Ad System

Ads Misc

This section is relevant if you are displaying ads, regardless of the ad network you choose. The "Disable Ads After Purchase" option does exactly what it states: if a player makes a purchase through the in-app purchase (IAP) system, all automatic ads (e.g., ads between levels) will be disabled. If you prefer to show ads between levels but not too frequently—just occasionally to generate revenue without overwhelming your players—you can adjust the "Chance of Videos Between Levels" to increase or decrease their frequency. If you're using multiple ad networks, you can prioritize the top three. This means if the first network fails to deliver an ad, the system will automatically query the second, and if necessary, the third. In the U.S., networks like AdMob or UnityAds typically always return an ad, but this may not be the case outside the U.S., especially with targeted ads. If you set up multiple ad networks within the Freemium Starter Kit, they are managed through a unified API. For instance, when you request to show an interstitial ad, the system will check all your configured ad networks in the order of priority to find the first one that can deliver the ad. Keep in mind that not all ad networks support every type of ad. The Freemium Starter Kit will strive to fulfill your ad requests based on the capabilities of your chosen ad networks and their set priorities.

Admob Options

If you've decided to use AdMob, your first step is to download and install the SDK. Trying to enable AdMob in the editor without installing the SDK first will lead to compiler errors. Use the "Open URL" button to access the AdMob website and download the necessary files. Next, you'll need to sign up for an AdMob account. Once your account is set up, you can configure the Freemium Starter Kit with the types of ads you plan to use in your game. If you choose Reward Video or Reward Interstitial, these will be integrated into the built-in reward system automatically. If you set up regular Interstitial ads, they will automatically display between levels if you've activated this feature. Ad banners, however, must be triggered manually using a simple API call and can appear on any screen that inherits from ScreenBase. For guidance on implementing this, please refer to the example game provided.

UnityAds

If you've opted to use UnityAds, your first step is to create an account. After signing up, you'll need to activate the Ads service. Go to the Services tab, select Ads, and turn on UnityAds. Remember, enabling UnityAds in the editor without first installing the UnityAds package will lead to compiler errors. To proceed, use the "Unity Dashboard" button to navigate to the UnityAds website where you can sign up for a UnityAds account. UnityAds requires separate ad IDs for Apple and Android devices. Once these are set up in the dashboard, you'll need to reference them in your project. The Video Placement IDs act as tags. After setting them up in the Dashboard and referencing them in your project, the Freemium Starter Kit will manage the rest automatically.

Ads Advanced

The advanced options enable you to prioritize ad networks based on the player's region. You can assign your first, second, and third priority ad networks for each major region, including India, Asia, Europe, North America, and South America.

Social Media

Social Media Options

If you want to enable users to share your game on social media, this section helps manage what they share. Here you can configure how users share your game with friends and family. This section begins with general information typically shared on platforms like Instagram, Facebook, or WhatsApp. Start by entering the game's name and a brief description. Next, provide a share URL. This URL should ideally be a redirect that automatically detects the user's device type and directs them to the appropriate app store—Google Play for Android users and the App Store for iOS users. I recommend using onelink.to for this purpose. The share picture should be a high-quality screenshot or logo of your game, hosted online. Images stored locally on your computer will not work. Messages for sharing are categorized into two types: general sharing and bragging. The API allows you to easily select which type to use. Typically, I enable bragging as an option after a player completes a level and set general sharing as part of a daily quest that offers a substantial reward. For ideas on what to include in each of these sections, please refer to the screenshots and the provided example game.

Facebook Options

If you've decided to use Facebook, your first step is to download and install the SDK. Failing to install the SDK before enabling Facebook in your project will cause compiler errors. The setup process is somewhat unique. Once you've registered your game with Facebook, you'll need to access the Facebook settings. This can be done either through the menu in the Facebook SDK or by clicking the button I've provided, both of which lead to the same place. In the settings, the most critical details are the App ID and Client Token you received upon registering your game with Facebook. Additional options and their explanations can be found on the page where you downloaded the SDK. After filling in all the necessary information, you must click "Build SDK Package" at the bottom of the page. Back in the Freemium Editor, click the "Read Facebook Settings" button to inform the Freemium Starter Kit (FSK) of your configurations. This step is essential because, although the Facebook SDK requires you to set up before beginning to code API calls, the FSK handles most of the coding for you. It just needs these details to function correctly.

Twitter Options

If you've chosen to integrate Twitter, an SDK is not necessary since most functionalities are handled through their API. The basic option enables users to like and follow your company or game page on Twitter. If you want users to share your content on their feeds, you must register your game with Twitter and obtain a key and secret. Note that registering with Twitter involves a review process of your game, which cannot be completed until your game is live.

Audio System

Background Music

Background music settings allow you to create a playlist for continuous background play. You can manually select any song to play at a specific time using an API call. Alternatively, activating the Autoplay feature lets the system randomly pick songs for you. After a song ends, it smoothly fades into the next. With the Music Loop Wait Time feature, you can set a specific duration for each song to loop. The song will continue to loop until this time period ends, and then it will complete its current playthrough before transitioning to the next song. The interval timer resets with the start of each new song. If a song's duration exceeds the set interval, it will play in its entirety just once before moving to the next track.

Ambient Sound Effects

Ambient sounds are background noises that enhance your game environment without being linked to specific events. These sounds can be continuous, like rain or the chirping of crickets, or they can occur randomly, such as intermittent birdsong. Each sound can be set with its own interval timer, creating a natural and varied auditory landscape. These sounds contribute atmospheric depth by playing either continuously or at intermittent intervals. Unlike background music, multiple ambient sounds can play simultaneously, enriching the audio environment.

System Sound Effects

This feature allows you to associate sound effects with specific system events, such as opening UI screens, clicking a button, crafting an item, or making a purchase. There are over 30 system events available for sound assignment. The designated sound effects will automatically play when these events occur in the game. Moreover, you can set up custom sound effects that can be triggered at any time via a simple API call. For instructions on how to implement this, please consult the example game provided.

Collections

Verify References

Collectables

Collectables are non-consumable items that players can store in their inventory. Each collectable can have various attributes: they can be craftable, equippable, provide stat bonuses, or be used as ingredients in crafting other items. For example, a ring might offer a 10% bonus to coin collection when equipped, or a glass bottle might be required to craft a healing potion. Tags: Once established, these tags can be assigned to each item to facilitate organization and searching within the inventory. Max Equippable Slots: This defines the total number of items a player can equip at any one time. If this capacity is reached, the system will automatically prevent the player from equipping additional items. To manage these items, click on "Open Editor" to access the Collectable Item Editor screen.

Consumables

Consumables are inventory items that trigger a specific effect when used. For instance, a consumable might restore health, expand inventory limits, or generate a protective shield. These items can be crafted from various combinations of collectables and other consumables. Tags: After you set up these tags, you can assign them to each item to assist with organization and efficient searching within the inventory. To manage these items, click "Open Editor" to access the Consumables Item Editor screen.

Rewards

Rewards are given to players as incentives or acknowledgments for their achievements within the game. These rewards can include a variety of items such as collectables, consumables, coins, gems, and stars. For example, when a player purchases a potion from the shop, it is the Reward System that adds this potion to their inventory. Similarly, the Reward System is responsible for distributing rewards when a player wins a level, completes a quest, or crafts an item. Basically, any time you need to give something to the player, use the Reward System. To manage these items, click on "Open Editor" to access the Rewards Item Editor screen.

Quests

Quests provide players with goals that aren't directly tied to gameplay, serving as a motivational tool. You can design quests to encourage behaviors players might otherwise overlook. For example, you could create a quest that rewards players for sharing the game on social media. Quests can also be used to monitor and reward a variety of in-game actions, such as opening shops, making purchases, crafting items, or accumulating specific resources. This system helps to engage players by rewarding their diverse activities within the game. To manage these items, click on "Open Editor" to access the Quest Item Editor screen.

Game Levels

If your game features multiple levels, this section allows you to configure them. You can lock levels until players collect a sufficient number of stars, establish rewards for completing each level, and set parameters for replayability. Score Tracking: This option lets you specify whether a higher or lower score is more desirable. Level Unlock Mode: Enables you to define the criteria needed to unlock each level. This setup helps tailor the progression system to enhance player engagement and challenge. To manage these items, click on "Open Editor" to access the Level Item Editor screen.

Games of Chance

Games of Chance manage random rewards within your game, such as a slot machine or a spin-the-wheel game. In this section, you designate the prizes and the percentage chance that a player wins each prize per attempt. Attempts at these games are referred to as "Spins," which players can acquire through purchase, gameplay wins, discoveries, or other methods. You will find an option to include Spins when setting up Rewards. Free Spin Max: This sets the maximum number of free spins a player can hold at one time. Spin Regen Interval: This defines the waiting period for a player to earn a new free spin after using one. Spin Reward Video: Players can earn a free spin by watching a video ad. This setting determines how long they must wait before they can watch another video to earn another free spin. To manage these items, click on "Open Editor" to access the Games Of Chance Item Editor screen.

Chests

Collections Continued Purchasable Products: "Purchasable Products" are items available in the game store. Players can acquire these items using various methods: locally with in-game currency like coins or gems, or by watching ads; and remotely as in-app purchases using real-world currency. Once a purchase is completed, the Rewards System automatically adds the item to the player's inventory or updates their stats as needed. Tags: Once you set up these tags, you can assign them to each item to aid in organizing and efficiently searching within the inventory. Unity IAP: Before enabling in-app purchasing, you must install the Unity In-App Purchasing service through the Services tab to avoid compiler errors. To manage these items, click on "Open Editor" to access the Purchasable Item Editor screen.

Achievements

Achievements serve as badges or trophies that recognize player accomplishments within the game, essentially offering bragging rights. For instance, while the game may only require players to collect 100 stars to win, there might be 150 stars available in total. Achievements can be used to acknowledge the extra effort players put in to collect all 150 stars. These achievements can be distributed as part of the Reward System or can be manually triggered within the game script as necessary. To use Achievements, you must turn on the Leaderboards. To manage these items, click on "Open Editor" to access the Achievements Item Editor screen.

Leaderboards

Leaderboards are remote scoreboards hosted in the cloud, allowing players to submit their high scores and compete with others. Depending on your game's design, you may need one or several leaderboards. To set up leaderboards, use the "Open URL" button to navigate to the Google Play Games website and install the Unity plugin. Ensure this plugin is installed before activating leaderboards in your game to avoid compiler errors. To manage these items, click on "Open Editor" to access the Leaderboards Item Editor screen.

Notifications

Notifications may seem like they are remote messages pushed to the player's phone, but they are actually generated locally. These notifications are an effective tool to re-engage players who haven't interacted with your game in a few days. You can set up notifications with a timer that prompts players to return to the game after a period of inactivity—typically 3 or 4 days. If the player returns to the game during this period, the timer resets, always ready to act after a new period of inactivity. Before enabling Local Notifications in your game, ensure you install Mobile Notifications version 1.3.2 or newer using the Unity Package Manager to avoid compiler errors. To manage these items, click on "Open Editor" to access the Notifications Item Editor screen.

Daily Prizes

The Daily Prize feature monitors the time since a player's last session and awards a prize if the player returns on a new day. These prizes serve as great incentives for players to keep engaging with the game. Tags: Once you establish these tags, you can apply them to each item to help organize and facilitate efficient searching within the inventory. Renew Type: This setting controls when the next daily prize becomes available. You can choose for it to renew on the next calendar day or after a specific amount of time has passed since the last prize was claimed. To manage these items, click on "Open Editor" to access the Daily Prize Item Editor screen.

Events

The Event Tracker allows you to monitor and respond to a wide range of data. The system automatically generates a notification for events such as the number of times the game has been played, total gameplay duration, days since the first play, days since the last play, or specific dates like Halloween. Simply select your data point, and the system will issue an event message once your predefined threshold is met. Search Tags: After setting up these tags, you can assign them to each item to enhance organization and improve search efficiency within the inventory. Event Tags: These tags help you identify the type of event that has been triggered, making it easier to manage and respond to different interactions within the game. To manage these items, click on "Open Editor" to access the Event Tracker Item Editor screen.

Screen Builder

Settings

These are the paths the Screen Builder will generate the base prefab and script file for your use.

Step 1

In this step, the Screen Name is important because it will determine the prefab and script names. In both cases, if an object already exists with that name, it will be overwritten with no undo. You may also select an existing prefab UI to edit or generate a script.

Step 2

This step has a button that will open the prefab selected in Step 1 in the Unity Editor.

Step 3

This step generates a script for the selected prefab. From here you can control how the script generator runs. Disable Raycaster Target: Turns off raycast target for UI objects that do not receive input. Reference Name Filter: Transforms, images, and text controls may or may not need a script reference. By default, Screen Builder assumes that they do not, so to help Screen Builder identify which of these it should create a reference for, you can identify them by adding this value "ref_" to the beginning of the control name. The default is “ref_” but you can change it to suit your needs. Check Boxes: Tells the script generator to create references for the selected control types. Transforms, images, and text controls will still need the Reference Name Filter as part of their name. Transform is unchecked by default because every object has a transform and it is a waste to parse through them all unless you specifically want to get a reference to one of them.