AntaresPrison

A Prisons plugin for any Spigot or Spigot fork, created for the Antares Network Minecraft server.

Antares Network Server

Join the Antares Network Discord server at https://discord.gg/KKYw763

You can find alpha builds in target with features from the latest commits, but these builds are not guaranteed to be free of bugs and it is not recommended to use them.

Migrate data

If you are updating the plugin, make sure to use /prisons migrate as soon as possible. That command will move all data from the old files into the new users file. If you won't execute that command, you may loose player data.

List of commands

• /prisons help -- Displays a list of the Plugin's commands
• /prisons regen -- Regen all mines
• /prisons regen {mine} -- Regen a particular mine
• /prisons balance -- Your prison balance
• /prisons balance {player} -- Prison balance of a player
• /prisons minelist -- List all mines
• /prisons reload -- Reload the plugin
• /prisons getseller -- Get a seller chest

List of Permissions

• prisons.receive_admin_messages -- allows the player to see .. well, the admin messages, about errors, infos, etc.
• prisons.regen -- allows the player to manually regen mines
• prisons.own_balance -- allows the player to check their own balance with /prisons balance
• prisons.other_balance -- allows the player to check other players balances
• prisons.list_mines -- allows the player to list the mines and their X,Y,Z coordinates
• prisons.autosell -- allows the player to autosell
• prisons.reload -- allows the player to reload the plugin
• prisons.get_seller -- allows the player to recieve a Seller Chest with /prisons getseller
• prisons.place_seller -- allows the player to place the seller chest down
• prisons.destroy_seller -- allows the player to destroy the seller chest
• prisons.modify_world -- allows the player to break blocks that arent in the mine
• prisons.damage_entities -- allows the player to damage entities in the mining world, like players and mobs
• prisons.place_sign -- allows the player to place the rankup signs
• prisons.skip_room -- allows the player to enter a room they have not bought the tier for yet

Tutorials

Creating a rankup sign

To create a rankup sign, you must use the format below.

[prison:ticket]  
{ticket name}
{price}

Example

[prison:ticket]
tier_2
20000

Adding a mine

To add a mine, you have to work with the mines.yml file. This file is generated when the plugin enables for the first time. Material Cheatsheet

Example file

mines:

  # The name of the mine, so how you reference to this mine in a command
  my_custom_mine:
    area:
      # Coordinates from
      fromx: 0
      fromy: 0
      fromz: 0
      
      # Coordinates to
      tox: 10
      toy: 10
      toz: 10
      
      # Location world
      world: 'prisons'
      
    # Materials that will spawn in the mine (See cheatsheet)
    materials:
      - 'STONE'
      - 'IRON_ORE'
      - 'GOLD_ORE'
      - 'COBBLESTONE'
   ...

Adding a room

To add a room, you have to work with the rooms.yml file. This file is generated when the plugin enables for the first time.

Example file

rooms:
  tier_1:
    ticket: 'tier_1'
    area:
      fromx: -8
      fromy: 26
      fromz: -76
      tox: 24
      toy: 4
      toz: -110
      world: 'prisons'
  tier_2:
    ticket: 'tier_2'
    area:
      fromx: -8
      fromy: 26
      fromz: -111
      tox: 24
      toy: 4
      toz: -143
      world: 'prisons'
   ...
      

Changing the worth of blocks

To change/set the worth of a block, you'll need the worth.yml file. Material Cheatsheet This is the format, you have to use:

MATERIAL_NAME: worth

Example file

OAK_LOG: 20.0
DIAMOND_ORE: 100.5

Other config files

The economy.yml and tickets.yml files do not need to be changed and are updated automatically.

v1.6 Update

Both economy.yml and tickets.yml files had been replaced with a database db_users.db.

Placeholders

• %prisons_balance% - This is the players balance. It is NOT tied to the Essentials economy in ANY WAY
• %prisons_tier% - This shows the highest mine tier that the player has unlocked

IMPORTANT DISCLAIMER

• This plugin does not generate the world for you and you must generate your own prisons world and then assign the coordinates of all of the mines in the mines.yml. You also need to tell the plugin where the doors to each of your rooms are in the rooms.yml file.

Check out our other projects here:

https://github.com/Antares-Network

License