📪Creating a Company

Step-by-Step Creation Guide

1. Locating the Configuration Folder

• Navigate to your server's root directory.

• Dive into the plugins folder and locate the TrueCompanies folder.

• Inside, you'll find a /companies folder. This is where the magic begins!

2. Generating Your Company's Configuration File

• Create a new .yml file within the /companies folder. The filename will serve as your company-id, so choose wisely!

  Example: For a company named "BlockCrafters", you might name the file BlockCrafters.yml.

3. Populating Your Configuration File

• Copy and paste the base template provided. This will give you a solid starting point.

displayName: Example Company
description: Best Company in the World
balance: 5000
chatFormat: '&7[&6{group}&7] &r{name}&7: &r{message}'
commands:
  on-fire:
    - "say %player% %player% has been fired!"

groups:
  '1':
    tag: 'Owner'
    permissions:
      can-hire: true
      can-fire: true
      can-deposit: true
      can-withdraw: true
      can-promote: true
      can-demote: true
      can-give-paychecks: true
    commands:
      on-promote:
        - "say %player% %player% is now a manager!"
      on-demote:
        - "say %player% %player% is now a manager!"
      on-hire:
        - "say %player% %player% is now the owner!"
  '2':
    tag: 'Manager'
    permissions:
      can-hire: false
      can-fire: true
      can-deposit: true
      can-withdraw: false
      can-promote: true
      can-demote: true
      can-give-paychecks: true
    commands:
      on-promote:
        - "say %player% %player% is now a manager!"
      on-demote:
        - "say %player% %player% is now a manager!"
      on-hire:
        - "say %player% %player% is now a manager!"
data:
  'PlayerName':
    group: 1

Comments:

• displayName: This is your company's public name.

• description: A brief description of your company.

• balance: Your company's starting balance.

• chatFormat: The format for your company's chat. Customize with color codes and placeholders.

• commands: Define commands that get executed on specific events, like hiring or firing.

• groups: Define the various roles within your company, each with its own permissions.

• data: Associate players with their respective roles.

First group (1) equals to the Owner of the Company

4. Customizing Your Company

• Naming & Branding: Edit the displayName and description to fit your company's theme and mission.

• Role Management: Within the groups section, set up various roles (like "Manager" or "Miner") and assign permissions based on their responsibilities.

• Player Assignments: Under the data section, associate your company's members with their roles.

Pro Tip: For complex companies, consider creating additional groups with unique permissions to streamline management!

---

Testing your Company Setup

Testing Your Company Setup

Once you've configured your company:

1. Execute /company reload in-game

2. Check in-game if the Owner has all the permission for that specific Company

3. Test out the permissions, commands, manage, and chat functions to ensure everything works as expected.

---

Advanced Configuration & Developer Tools

For those looking to dive deeper:

• API: Use our comprehensive API to customize and enhance your company's mechanics. Check out the API documentation for details.

• Events: Hook into specific events, like hiring or firing, to add custom behaviors and reactions.

---

🖥️API