Regulars

Basic Hierarchy

There is one regulars folder that contains all regular groups. Groups are stored in individual folders that can have any name you want to give them. In these folders there need to be one manifest.json and a config.json. The config contains the role information with playtime requirements and the manifest the name of the group and if there is a specific group role that should be applied.

---

Manifest.json

This is the general manifest.json, there shouldn't be any field names altered only the content and values

# The name of the group that will be displayed to the users
name: "Example"
# The description of the group that will be displayed to the users
description: "Just an example"
# The custom role will be a group role, given to all users that have selected this group
custom_role:
  use: false
  id: ""

NAME

the name of the regular group

DESCRIPTION

Short summary of the group

USE

Should the group use a custom overall group role that is going to be ap

ID

If there is a group role then add the id here

---

Config.json

This is the general config.json, there shouldn't be any field names altered only the content and values. You can also add as many fields as you want, this is pretty scalable

# The list of roles that will be available for users. To create more copy an already existing entry.
# To remove a regular, delete an entry.
roles: [
  {
    # The roleId of the role. Activate developer mode and right-click the role
    id: "",
    # The description of the role that will be displayed to the user
    description: "",
    # Which type of requirement do you want to use? The requirement_type will define if the role is given to the player when reaching a certain
    # playtime, a certain level, or both. Choose between the types: [PLAYTIME, XP, BOTH]
    requirement_type: "PLAYTIME",
    # Which playtime (in hours) does the user need to reach before getting the role?
    playtime_requirement: 25,
    # Which xp level (in end levels) should the user need to reach before getting the role?
    xp_requirement: 5
  },
  {
    # The roleId of the role. Activate developer mode and right-click the role
    id: "",
    # The description of the role that will be displayed to the user
    description: "",
    # Which type of requirement do you want to use? The requirement_type will define if the role is given to the player when reaching a certain
    # playtime, a certain level, or both. Choose between the types: [PLAYTIME, XP, BOTH]
    requirement_type: "PLAYTIME",
    # Which playtime (in hours) does the user need to reach before getting the role?
    playtime_requirement: 50,
    # Which xp level (in end levels) should the user need to reach before getting the role?
    xp_requirement: 10
  },
  {
    # The roleId of the role. Activate developer mode and right-click the role
    id: "",
    # The description of the role that will be displayed to the user
    description: "",
    # Which type of requirement do you want to use? The requirement_type will define if the role is given to the player when reaching a certain
    # playtime, a certain level, or both. Choose between the types: [PLAYTIME, XP, BOTH]
    requirement_type: "PLAYTIME",
    # Which playtime (in hours) does the user need to reach before getting the role?
    playtime_requirement: 100,
    # Which xp level (in end levels) should the user need to reach before getting the role?
    xp_requirement: 15
  },
  {
    # The roleId of the role. Activate developer mode and right-click the role
    id: "",
    # The description of the role that will be displayed to the user
    description: "",
    # Which type of requirement do you want to use? The requirement_type will define if the role is given to the player when reaching a certain
    # playtime, a certain level, or both. Choose between the types: [PLAYTIME, XP, BOTH]
    requirement_type: "PLAYTIME",
    # Which playtime (in hours) does the user need to reach before getting the role?
    playtime_requirement: 150,
    # Which xp level (in end levels) should the user need to reach before getting the role?
    xp_requirement: 20
  },
]

ID

The id of the playtime role

DESCRIPTION

A short description of the roles purpose/lore or smth. else

REQUIREMENT_TYPE

You can choose what type of requirements for obtaining the role should be used, choose from PLAYTIME, XP or BOTH

PLAYTIME_REQUIREMENT

How much playtime (in hours) must a user have to acquire this role

XP_REQUIREMENT

What level should the user have to acquire this role