For the complete documentation index, see llms.txt. This page is also available as Markdown.

Layouts

Layouds (Designs)

Here you can find some ready-made designs that you can use in your configuration.

inventories:
  streak:
    rewards:
      config:
        slots: 0,9,18,27,28,29,20,11,2,3,4,13,22,31,32,33,24,15,6,7,8,17,26,35,44,53
Image


inventories:
  streak:
    rewards:
      config:
        slots: 3,4,5,11,12,13,14,15,19,20,21,22,23,24,25,28,29,30,31,32,33,34,38,39,40,41,42,48,49,50
Image


Image


Image


Image

Create PlayTime and Streak Rewards

In this guide, you'll learn how to configure rewards for the PlayTime (time played) and Streak (login streak) menus within the TheRewards plugin.

🎯 Goal

Set up visual and interactive rewards for players based on:

  • Time connected to the server (PlayTime)

  • Daily login streak (Streak)

πŸ“ Configuration Structure

Rewards are defined inside the layouts.yml file, specifically in the sections:

  • inventories.streak.rewards.days

  • inventories.playtime.rewards.times

🧱 Configure Streak Rewards

βž• Add a new day

πŸ“Œ Important Fields

  • day: Streak day number.

  • actions: List of commands or messages to execute upon claiming.

  • requirements: Optional conditions using placeholders. You can omit the requirements section if no extra conditions are needed.

⏱️ Configure PlayTime Rewards

βž• Add a new playtime reward

πŸ“Œ Important Fields

  • play-minutes: Number of minutes required to claim the reward.

  • actions: List of commands and messages to execute.

  • requirements: Optional conditions using placeholders. You can add as many reward blocks as you likeβ€”just make sure play-minutes is an integer greater than the previous one.

🎨 Visual Customization

Items in the menu are auto-generated, but you can customize their appearance from:

  • items.available

  • items.waiting

  • items.claimed

  • items.unavailable

In those sections, you can modify:

  • material

  • display_name

  • lore

  • model_data

  • Custom textures using basehead-<encoded_value>

ℹ️ More info: See the "Material" section on the wiki.

πŸ“Ž Supported Actions

  • [command]: Runs a command (you can use {player} for the player's name).

  • [message]: Sends a message to the player.

  • [openmenu]: Opens another TheRewards menu.

  • [close]: Closes the menu.

ℹ️ More info: See the "Actions" section on the wiki.

Last updated