⚙️First Install

How to install the plugin

Stage 1: Plugin Installation

1. Stop your server.

2. Download the latest version of BedHome.

3. Put the BedHome.jar file inside your plugins folder.

4. Start your server.

5. Wait for the server to start and for BedHome to load all the files.

---

Stage 2: Database Configuration

Before you start using the plugin, you need to configure it. To do this, navigate to the BedHome folder in your plugins directory.

Open the plugin's config.yml file and go to the database section. It should look like this:

...
database:
  # Choose where you want to store player data. You have the option of SQLite or MySQL.
  type: SQLite
  # Configuration of the MySQL database connection.
  host: 'localhost'
  port: 3306
  database: 'database'
  username: 'root'
  password: 'password'
...

At the beginning, choose the type of database you want to use on your server. You have two options:

1. SQLite: A simple and fast database for smaller servers. Ideal for beginners who want to easily configure player homes.

2. MySQL: Performance and scalability for ambitious servers. Provides the ability to handle a large number of players and better data control. Choose MySQL to expand your server on a larger scale.

Select one of them and enter it in the type: field:

If you choose SQLite, that's it, and you can proceed to the next step. However, if you choose MySQL, configure the connection to it by entering the following in the fields:

• host: MySQL database host address (e.g., localhost)

• port: MySQL database port (default is 3306)

• database: Name of the database you want to connect to.

• username: MySQL username with privileges for the database.

• password: MySQL user password.

Once you've done this, restart the server for the changes to take effect.

Stage 3: Homes System Configuration

After setting up the database, you need to configure the homes system. Open the plugin's config.yml file again and look for the settings: section. This is where you can define various settings related to player homes.

settings:
  disallowedInWorlds:
    - 'world_nether'
    - 'world_end'
  defaultSlots: 3
  defaultPurchaseSlots: 9
  maxHomeSlots: 54
  teleportWarmupSeconds: 5
  teleportCooldownSeconds: 10
  economyFormula: '1000*{slot}'
  displaynameMin: 3
  displaynameMax: 10
  displaynameRegex: ''

1. disallowedInWorlds: A list of worlds in which the command does not work.

2. defaultSlots: The default number of slots for homes available to new players.

3. defaultPurchaseSlots: The default number of slots available for purchase.

4. maxHomeSlots: The maximum number of slots for homes.

5. teleportWarmupSeconds: The warm-up time before teleportation in seconds.

6. teleportCooldownSeconds: The cooldown time before the next teleport in seconds.

7. economyFormula: The formula for calculating the cost of purchasing a slot. Variables:

   • {slot} - The slot number being purchased.

   • {slots} - The number of slots unlocked by the player.

8. displaynameMin: The minimum number of characters for a home's display name.

9. displaynameMax: The maximum number of characters for a home's display name.

10. displaynameRegex: A regex method to exclude unwanted characters in the name.

Adjust these settings to tailor the functionality of the BedHome plugin according to your server's specific needs and preferences. Make sure to save the changes and restart your server for the adjustments to take effect. This way, you can ensure that the homes system operates exactly as desired for your Minecraft players.

Stage 4: GUI Configuration

Configuring the graphical user interface (GUI) for the BedHome plugin can enhance the user experience. Your config.yml file already contains a section dedicated to GUI settings. Here's how you can customize it:

🪟GUI Formatting

Stage 5: Messages Configuration

Messages play a crucial role in communicating with players and guiding them through the functionalities of your BedHome plugin. By configuring message settings, you can replace default messages with custom ones that resonate better with your server's theme and community.