💻Bukkit

Step 1 - Install the plugin

As you might know, it's pretty simple to install a bukkit plugin. In case you don't read this carefully.

So in order to install the plugin, you need an already setup bukkit (or any bukkit fork) server which already has a folder called plugins in it. Now it is as simple as dragging and dropping the plugin jar file into this folder.

The final step is to reboot your server, the plugin will enabled itself and create a folder in plugins/PlayerPoof

Step 2 - License

Read this section only if you own a PlayerPoof license and account.

Once you restarted your server, you will notice an error saying "Your license is not valid!", which is perfectly normal at this point.

# +-------------------------------------------------------------------------+ #
# |                     ╔═╗┬  ┌─┐┬ ┬┌─┐┬─┐  ╔═╗┌─┐┌─┐┌─┐                    | #
# |                     ╠═╝│  ├─┤└┬┘├┤ ├┬┘  ╠═╝│ ││ │├┤                     | #
# |                     ╩  ┴─┘┴ ┴ ┴ └─┘┴└─  ╩  └─┘└─┘└                      | #
# |                                                                         | #
# |                         Developed by StellarDev                         | #
# |                            www.stellardev.org                           | #
# |                                                                         | #
# |                         ------------------------                        | #
# |                                                                         | #
# |                              LICENSE FILE                               | #
# |                                                                         | #
# |              Type your license key in the following field.              | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

key: "YOUR LICENSE KEY HERE"

You will need to enter your license key in the plugins/PlayerPoof/license.yml file and restart your server again.

In case your server still doesn't start, feel free to join our discord and open a ticket, we'll do our best to help you out.

Step 3 - Configuration

This is by far the most important part of the process, it will define how the plugin interact with your server.

We know configuration of a plugin can give massive headaches, so we're going to go through each section and important key in detail.

First of all, you need to locate the configuration file in plugins/PlayerPoof/config.yml and open it.

1. Visibility options

The visibility options let you chose if your virtual players should spawn and be visible to other players spawn-poof-players and if they should appears in your server tablist show-in-tab

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                           VISIBILITY SETTINGS                           | #
# |                                                                         | #
# |        Controls how your poof players appears to regular players.       | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

visibility:
  # This option stands for the visibility of the poof players
  # in the tab list.
  show-in-tab: true

  # This option allows you to spawn the poof players
  # as regular players. It can be required for some
  # modules to works properly.
  spawn-poof-players: true

2. Name options

There you can define blacklisted names, such as staff names, to avoid having virtual players joining the server with staff username or famous players names.

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             NAMING SETTINGS                             | #
# |                                                                         | #
# |                       Manage spoof players' names.                      | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# All names in the following list will be excluded from the
# name generator. You can add as many names as you
# want, but you must respect the YAML syntax.
blacklisted-names:
  - 'Notch'
  - 'Technoblade'
  - 'Dinerbone'

3. Plugin settings

In this section you can tweak plugin settings. The first section is meant to edit the base command and its aliases. I think is pretty self explanatory, this option has been created to allows you to hide the fact that you are using PlayerPoof by changing the original command by any other command.

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             PLUGIN SETTINGS                             | #
# |                                                                         | #
# |                  Manage who can see and use the plugin.                 | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# This option let you define the command used to
# execute the plugin. You can change it to whatever
command: 'playerpoof'

# And there are the aliases for the command.
command-aliases:
  - 'poof'
  - 'pp'

The whitelisted-players option is only for server running under MC 1.13, it allows you to define who can use the plugin and have the tab completion for /poof and /playerpoof commands.

The second option called join-commands let you define commands that will be run by the server when a virtual player joins your server, you can use the placeholder %player% to get the virtual player name.

# Add your username or uuid here to gain access to the in-game Poof
# commands using /poof. This is to ensure others with full perms cannot
# see the plugin exists.
whitelisted-players:
  - 'Poof'

4. Join commands

This section is used to configure commands executed on virtual players join.

# The following option allows you to make the console
# execute a list of commands when the poof players
# join the server.
# You can use %player% to get the poof player's name.
join-commands:
  1:
    command: "say Hello %player%!"
    console: true # true = executed by the console, false = executed by the player
    # Set delay to 0 to execute the command instantly.
    delay: 10 # in seconds

As you can see, you can define multiple commands, each command MUST have an unique identifier, as in the example where the command as the identifier 1.

For each command you can configure the delay and how the command is executed. If you set the console option to true, the command will be executed by the console, otherwise by the virtual player itself.

You also can configure the delay between the virtual player join and the command execution by tweaking the delay field, if you don't want any delay, just turn it to 0.

5. World settings

In this configuration section you can tweak world related settings.

The spawn section allows you to define where the virtual players will spawn. It only works if you enabled the spawn-poof-players option.

Then the auto-respawn option can be turned to true|false, depending on if you want your virtual players to respawn when they dies.

The next section dropped-items let you enable/disable the item pickup feature by turning the enabled key to true|false. You also can configure the delay between the moment the item on ground is detected by the player and the moment it is picked up by the poof player.

And the final section gravity, let you enable/disable the artificial gravity feature that reproduce normal minecraft gravity for virtual players. You can tweak the velocity of the gravity, aka its strength. Note that it must be between 0 and 1.

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                              WORLD SETTINGS                             | #
# |                                                                         | #
# |           Control how poof players interacts with your worlds.          | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #

# This option defines the world where the poof players
# will be spawned. You must enable the "spawn-poof-players"
# option to make this one works.
#
# Note: if the world doesn't exist, the poof players will
# be spawned in the default world.
spawn:
  world: "world"
  x: 0.0
  y: 0.0
  z: 0.0

# This option allows you to control if the poof players
# should be able to respawn when they die or not.
auto-respawn: true

dropped-items:
  # This option allows you to control if the poof players
  # should pick up nearby items or not.
  enabled: true

  # This delay defines the minimum time before
  # the poof players can pick up an item. (in ticks)
  minimum-delay: 10

  # This delay defines the maximum time that
  # the poof players can wait before picking up
  # an item. (in ticks)
  maximum-delay: 30

gravity:
  # This options allows you to control if the poof players
  # should be affected by gravity or not.
  enabled: true

  # This option allows you to control how fast
  # the poof players falls down.
  #
  # This value must be higher than 0.
  # Recommended value: 0.5
  velocity: 0.57

6. Messaging settings

Please refer to the following page to learn and understand how to configure messaging services:

🔌Messaging services

7. Update notifications

This option let you choose if you will receive a notification each time a new update is being released.

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                          UPDATES NOTIFICATIONS                          | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #
# This option allows you to disable the update notifications.
update-notifications: true

Step 4 - Modules

NOTE: In order to use modules, you need the premium version of the plugin and to purchase each module separately or having them included in your license.

Regarding the modules we reproduced the bukkit plugins system, let me explain that:

Once the plugin started up, it created a folder located at plugins/PlayerPoof/modules, as for a regular bukkit plugin you have to drag and drop your modules in this folder and reboot the server.

We won't detail how to configure each module there, but you can look through the left menu to find what you need to start.

Step 5 - Enjoy

Simple, isn't it? Now you can sit back and relax while our software cares about the rest!