Velocity/Bungeecord Setup

This setup is only for servers that run on a Velocity/Bungeecord network.

Step 1 - Enable the plugin on proxy.

First you will need to place the HalosPlayerSpoofer plugin on the Velocity or Bungeecord server. Configure the Redis or Mysql DB in the config.yml

MySql Example

 database:
   # Possible values: SQL, REDIS or NONE
  type: SQL
  sql:
    url: jdbc:mysql://localhost:3306/spoofer
    username: root
    password: password

Redis Example

 database:
  # Possible values: SQL, REDIS or NONE
  type: REDIS
  redis:
    url: redis://loca1host:6379
    password: password

After you input your Database information, restart the Velocity/Bungeecord server. Ensure there are no errors. Then move onto Step 2.

Step 2 - Connect Spigot Server

In the configuration of the spigot server, toggle on the proxy mode setting to true.

  # If you wish to run Spoof within a proxy,
  # enable this and specify controller settings below.
  proxy-mode: true

Next, you must also specify your server-id. This server-id is case sensitive. You must type exactly what is in your velocity.toml/config.yml(bungeecord) proxy server files. To what is specified for the spigot server you are configuring the spoofer on. If you do not set the correct id or typed incorrectly the sync will not work.

  # This is your unique server identifier, this MUST be
  # set if using a proxy - e.g. BungeeCord.
  server-id: Test

Finally, similar to the setting up the proxy configuration, you will need to connect the MySQL or Redis DB.

MySql Example

 database:
    # Possible values: SQL, REDIS or NONE
    type: SQL
    sql:
      url: jdbc:mysql://localhost:3306/spoofer
      username: root
      password: password

Redis Example

database:
  # Possible values: SQL, REDIS or NONE
  type: REDIS
  redis:
    url: redis://loca1host:6379
    password: password

Once you configure all the settings. You must restart your spigot server, and ensure there are no errors.

Step 3 - Repeat

Once you have configured both Proxy and Spigot server. You will be able to see Fake player counts reflect in the server list counts. If you have multiple spigot servers, repeat Step 2 on all your additional servers. Ensure that the server-id is not the same for multiple spigot servers or else the sync will not work.

Step 4 - Configure Command

Commands will now be processed from the proxy instance. You should configure a custom command name. Found in halosplayerspoofer/config.yml

# Disguise the plugin how ever you wish.
# You can Change all the following fields below.
plugin-disguise:
  # When running a network, it is recommended to set this to the same value on each server AND proxy.
  spoof-command: spoof

Step 5 - Configure Server Fallbacks

When one of your spigot servers shut down, configure the fall back server to where fakes will go to once the spigot server they are on shuts down.

 fallback-server-ordering:
  - spoof
  - spoof2

Step 6 - Configure Spigot Server Flucuation

Due to HalosPlayerSpoofer 3.0 update, all fluctuation is now configured and controlled on the proxy instance.

If you navigate to halosplayerspoofer/servers you will find a config file for each spigot server on your network.

HalosPlayerSpoofer must be installed on the spigot server in order to work with the server you configure. If you choose to not spoof on a spigot server there is not need to add the plugin to the backend and you can disable the server in the configuration.

This is an example of the flucuation configuration that will appear for each server.

# The minimum interval between fluctuation ticks.
min-tick-interval: 5s

# The maximum interval between fluctuation ticks.
max-tick-interval: 30s

# The default fluctuation options, if no day/time specific config is active.
options:
  # If the fluctuation module should be active during this time.
  active: true

  # The absolute maximum number of fake players to allow on the server, after calculating the random fixed players and adding a multiple of real players.
  max-total-fake-players: 200

  # Define how many real players need to be online before fluctuation will start.
  # If set to -1, fluctuation will always run.
  min-real-players: -1

  # The chance to add to or subtract from the target fake player count on each tick (0-100).
  # Increase to get joins and leaves more often (less stable player count), decrease to get joins and leaves less often (more stable player count).
  random-walk-chance: 25

  # The minimum amount of fixed fake players to add.
  min-fixed-fake-players: 50

  # The maximum amount of fixed fake players to add.
  max-fixed-fake-players: 100

  # The minimum multiplayer to use for the dynamic player count (gets multiplied by real player count to add more fake players)
  min-real-multiplier: 0.5

  # The maximum multiplayer to use for the dynamic player count
  max-real-multiplier: 1.5

  # The minimum time a fake player stays online.
  min-lifespan: 5m

  # The maximum time a fake player stays online.
  max-lifespan: 1h

Once you specify all the proper configurations run /spoof reload to reload the configurations and apply your new settings with out having to restart the proxy instance.