Skip to content

Premium Shop Guide

Below is a detailed guide for configuring and using the Premium Shop within the system, styled similarly to Fivemon’s official documentation. It covers the purpose of the shop, its main functionalities, and how to define news, daily rewards, and battle passes.

What Is the Premium Shop?

The Premium Shop is a system designed to provide players with additional or exclusive content. From a single interface, you can:

  • Display news (announcements, events, updates, etc.).
  • Offer daily rewards, encouraging players to log in regularly.
  • Feature battle passes with progressive reward tiers.

This feature helps maintain player engagement and loyalty, while also offering opportunities for monetization or further customization of the player experience.

Key Features

  1. News

    • Sections to showcase announcements and promotions with images, descriptions, and links.
    • Enables you to configure multiple news items simultaneously.

  2. Daily Rewards

    • Different reward “sets” that provide items each day. Each set has its own start/end dates, title, description, and list of items to be distributed.
    • Ideal for time-limited promotional campaigns.

  3. Battle Pass

    • A tier-based reward system that incentivizes players to complete challenges or simply stay active.
    • Includes a free tier and various premium tiers with different price points and rewards.

  4. Appearance Customization

    • Ability to use a background video or image to personalize the shop’s look and feel.
    • Configuration of external URLs.

Configuring Premium Shop

Before diving into these details, you must place the Premium Shop configuration in the uri-config\data\config\config.json file. For a thorough explanation on how to structure JSON configurations, please refer to the previously published Configuration guide. This ensures that the shop data is properly loaded and recognized by the system.

Configuring News

In the JSON file, the news section is defined under the premium_shop.news array. Each news item has:

  • name: A unique identifier or UUID.
  • title: The headline shown to players.
  • description: A brief explanation of the news or announcement.
  • image: A URL to the image displayed alongside the text.
  • url: An external link for more information (e.g., taking players to a web page).

Example Configuration:

{
    "name": "fc1a26bf-e75d-4cf8-8358-be210f46e20f",
    "title": "New Premium Shop 1",
    "description": "The Premium Shop 1 is now open!",
    "image": "https://wallpapercat.com/w/full/1/4/7/34679-1920x1080-desktop-1080p-pokemon-anime-background-image.jpg",
    "url": "https://fivemon.gg"
}

Key Points:

  • You can add as many news items as needed.
  • Make sure all images and URLs are valid to avoid broken links.

Configuring Daily Rewards

Daily rewards are managed through distinct sets, each with its own time validity and a list of items distributed daily based on player login.

Structure

Inside the premium_shop.daily_rewards array, each element represents a new daily rewards set with the following fields:

  • name: Internal identifier (e.g., daily_rewards_set_0).
  • title: A descriptive name displayed to players.
  • description: Short text explaining the set.
  • image: Image URL to visually represent the set in the interface.
  • starts / ends: Start and end dates of the promotion (in MM/DD/YYYY format).
  • rewards: An array representing the items to be granted each day:
    • item: The name of the item.
    • amount: The quantity of that item.

Example and Observations

{
    "name": "daily_rewards_set_0",
    "title": "Daily Rewards Set 0",
    "description": "The Daily Rewards Set 0 is now open!",
    "image": "https://images3.alphacoders.com/105/1052108.jpg",
    "starts": "03/01/2025",
    "ends": "04/01/2025",
    "rewards": [
        {
            "item": "bread",
            "amount": 2
        },
        {
            "item": "bread",
            "amount": 1
        }
    ]
}
  1. Each object in rewards corresponds to a different day. The first entry is Day 1, the second is Day 2, and so on.
  2. If the number of rewards in the set exceeds the total days between starts and ends, any extra rewards beyond the last valid day are discarded.

Configuring the Battle Pass

The battle pass is a system that rewards players as they progress through various levels or tiers.

Structure

Within premium_shop.battle_passes, you will find an array in which each element is a new battle pass containing:

  • name: The internal identifier of the pass.
  • label: The name displayed to players (e.g., “April Battle Pass”).
  • starts / ends: The start and end dates for the pass.
  • free_tier: Contains:
    • label: The name or tag for the free tier.
    • rewards: The array of items/quantities for each level.
  • premium_tiers: An array of paid tiers, each with:
    • label: Name or category (e.g., “Bronze”, “Silver”).
    • price: The cost in premium currency or points.
    • rewards: The array of items/quantities for each level.

Example and Important Details

{
    "name": "april_battle_pass",
    "label": "April Battle Pass",
    "starts": "04/01/2025",
    "ends": "04/30/2025",
    "free_tier": {
        "label": "Free",
        "rewards": [
            {
                "item": null,
                "amount": 1
            },
            {
                "item": "bread",
                "amount": 1
            }
        ]
    },
    "premium_tiers": [
        {
            "label": "Bronze",
            "price": 2500,
            "rewards": [
                {
                    "item": "bread",
                    "amount": 5
                },
                {
                    "item": "bread",
                    "amount": 10
                }
            ]
        },
        {
            "label": "Silver",
            "price": 2500,
            "rewards": [
                {
                    "item": "bread",
                    "amount": 5
                }
            ]
        }
    ]
}
  1. When item is null, that particular level does not provide any reward.
  2. Each position in the rewards array corresponds to a specific level or checkpoint in the battle pass.

Additional Considerations

  • Date and Format Consistency: Always ensure that starts is earlier than ends and that the date format matches what your system expects.
  • System Validations: Our system has certain validation mechanisms to handle inconsistencies (e.g., missing essential fields or date overlaps). However, it is recommended to carefully verify your entries to prevent errors.
  • Asset Links: Confirm the availability of any media you reference, such as the videoBackground or any image URLs.

Conclusion

The Fivemon Premium Shop is a comprehensive tool for offering announcements, daily incentives, and a tier-based reward system. By editing a well-structured JSON file, you can:

  • Publish news to keep players updated.
  • Motivate daily logins with daily reward sets.
  • Implement one or more battle passes to provide progressive rewards.

Follow the guidelines and examples above to ensure a smooth and engaging experience for your players. Experiment with configurations, customize visuals, and tailor the system to your specific needs!