The Meta Mod is used to assist in creating and managing unit cards, based on metagame mechanics in Clash Royale, as well as other meta-game features.

• "Review Invite" prompt
• Create and manage cards with level progression
• Level up cards with shards + currency (either gold or a custom currency)
• Automatically applies health and damage scaling values to card-associated units
• Automatically manages save data for card progression (unlock state, level, shards)

Download the demo map here or play it on the arcade!

• To use this mod, add the meta registry module to your project using the latest version ^1.0.0.

The following functions can be used such as:

local meta = require("meta")

local card_data = {
  name = "basic_range",
  progression = meta.ProgressionTemplates.Common,
  units = {
    "Standard RangedUnit",
  }
}

-- creates a new card using the supplied card_data
meta.Card:New(card_data)

Defines a new card using the supplied card data. You should use this function to define all the cards in your project in your map initialization function before calling meta.LoadPlayerData.

card_data values:

• name defines the card name for it to be referenced elsewhere.
• progression a progression table that defines parameters of the card's progression.
• units a list of units that will receive health and damage scaling based off of progression table values.

You may find it useful to add your own values to card_data, such as:

local card_data = {
  name = "basic_melee",
  display_name = "Footman",
  icon = "btn_unit_wildsky_barracks_troop_rank01",
  rarity = "Common",
  progression = meta.ProgressionTemplates.Common,
  units = {
      "Standard MeleeUnit",
      "Standard MeleeUnit Rank 2",
      "Standard MeleeUnit Rank 3",
  }
}

Attempts to level up the given card, first checking required upgrade cost and required shards. If successful, the card will leveled up, the required shards will be consumed, and the health and damage scaling upgrade behaviors will be updated for relevant units.

Note that the upgrade cost will not be consumed (but the resulting value will be returned in the result_callback function) and must be handled in your own script. It's also recommended to call SavePlayerData() in the result_callback function.

Options

• (optional) custom_currency if set, card cost will check against this value rather than DCEI.GetGold().
• result_callback this function will be called after the function is finished running with the following result parameters:
  • is_success will return true if the card was successfully leveled up.
  • currency will return the new currency value after the upgrade cost has been subtracted.

meta.mod.CreateReviewInvite(settings)

Creates an invitation for players to review your game. First this asks players to rate the game 1-5 stars. If 5 stars are chosen, the user is prompted to leave in actual review in the google play store.

• table settings arguments for hooking up the layout.
  • string url Store page URL. For Google Play page https://play.google.com/store/apps/details?id=com.wildsky.td the URL would be "market://details?id=com.wildsky.td" - replace the last part (com.wildsky.td) with the similar part of the URL from your store page.
  • (optional) transform parent frame to create the UI in. Defaults to root.
  • (optional) function finish_function(rating, accept_invite) this function will run when the user finishes the review invite, and will pass the chosen star rating (from the initial prompt, not the official rating given in the google play store) as well as "accept_invite" which determines if the user accepted the request to leave an official review in the google play store. (There is no way to know if they did after they open the URL)

    meta.CreateReviewInvite({
        parent = DCEI.GetUiRoot(),
        finish_function = function(rating, accepted_invite) 
            DCEI.LogMessage("Optional function to run when the Review Invite completes")
            DCEI.LogMessage("Receives the star rating chosen: " .. tostring(rating))
            DCEI.LogMessage("And if they accepted prompt to visit store: " .. tostring(accepted_invite))
        end,
        url = "market://details?id=com.pocket.defender"
    })

The following functions can be used such as:

local meta = require("meta")

-- load player card save data
meta.LoadPlayerData()

-- finds the card associated the the unit "Standard MeleeUnit"
local unit = DCEI.FindUnit( "Standard MeleeUnit" )
local card = meta.GetUnitCard( unit )

card:SetUnlocked( true )

-- save and commit player card save data
meta.SavePlayerData()

Saves the level, shard, and unlocked properties of each card to the player's save file.

Loads the level, shard, and unlocked properties of each card from the player's save file. Call this in your map initialization function after all of the cards have been defined with Card:New().

Cards must be given a progression table that defines the following values per level:

• shard_required the number of shards required to upgrade to that level
• upgrade_cost the currency cost to upgrade to that level
• health_scale the health value for that level (as a percentage of base health)
• damage_scale the damage value for that level (as a percentage of base damage)

The library also comes with a number of pre-defined progression table templates ready for use.

Example progression table:

local progression_table = {
  {
    shard_required = 0,
    upgrade_cost = 0,
    health_scale = 1.00,
    damage_scale = 1.00,
  },
  {
    shard_required = 2,
    upgrade_cost = 10,
    health_scale = 1.05,
    damage_scale = 1.05,
  },
  {	
    shard_required = 4,
    upgrade_cost = 20,
    health_scale = 1.1,
    damage_scale = 1.1,
  },
}

The following predefined progression tables can be used as such:

local meta = require("meta")

local common_progression = meta.ProgressionTemplates.Common
local rare_progression = meta.ProgressionTemplates.Rare
local epic_progression = meta.ProgressionTemplates.Epic
local legendary_progression = meta.ProgressionTemplates.Legendary

Full table values can be viewed here.

Note that Rare/Epic/Legendary still start at level 1 (when getting card level from Card:GetLevel()) and simply have a lower max level. For this reason the default progression templates additional include the display_level property, which is used for level display in the demo map to have Rare/Epic/Legendary cards start at level 3/6/9.

• Added Review Invite functions

• Released