Skip to content

Setup

Jump to bottom
Dylan Ryman edited this page Feb 6, 2015 · 12 revisions

OK good! You downloaded plugin, and you are actually taking the time to read this. You wouldn't believe the number of people who download plugins, pop the in the plugins folder, and expect it to magically work. :/

Once you have put the plugin in your plugins folder, start the server, and just stop the server there. Do nothing else. Simply issue the /stop command.

The first thing we will do is take a look at the config file. As of the last time I have updated this page, this is what it looks like:

# Survival Games Config File
# This is a community project, join in http://dev.bukkit.org/bukkit-plugins/the-survival-games/.

# Bungeecord Mode  DO NOT USE THIS RIGHT NOW, I HAVE NOT EVEN RELEASED THE PROXY YET
bungeecord-mode: false

# SETTINGS IF BUNGEECORD MODE IS TRUE

# Define if the server should be a hub
hub-server: false

# END THOSE SETTINGS

# Allow Double-Jump in game
allow-double-jump-IG: false

# Allow Double-Jump in lobby
allow-double-jump: true

# Default points for new players
default-points: 100

# World to display the scoreboard and prevent block breaking
hub-world: world

# Welcome message
welcome-message:
  - '&eHi there, and welcome to'
  - '&a&lThe Survival Games Server'
  - '&2Read the book in your inventory for more information'

# Please enter acceptable item names, which can be found in http://jd.bukkit.org/rb/apidocs/org/bukkit/Material.html
breaks-allowed:
  - 'LEAVES'
  - 'LEAVES_2'
  - 'BROWN_MUSHROOM'
  - 'RED_MUSHROOM'
  - 'VINE'
  - 'WHEAT'
  - 'WEB'
  - 'CARROT'
  - 'POTATO'

I'm going to go over this option by option.

# Bungeecord Mode  DO NOT USE THIS RIGHT NOW, I HAVE NOT EVEN RELEASED THE PROXY YET
bungeecord-mode: false

The first option, Bungeecord Mode, is currently not ready. I am working on a Bungeecord Plugin that will link points, kills, arenas, and other useful stuff across a Bungeecore server network.

The next few options have to do with the Bungeecord Mode; thus, I will not be covering them yet.

# Allow Double-Jump in game
allow-double-jump-IG: false

This will allow players to double jump whilst in a SG game. Not recommended for traditional SG style servers, but I thought I'd throw this here anyway.

Note: This will also disable any and all fall damage in an SG game as well.

# Allow Double-Jump in lobby
allow-double-jump: true

Allows players to double jump ONLY IN THE SG LOBBY WORLD (We'll get to that later), trust me, players like to double jump. It's fun.

# Default points for new players
default-points: 100

This is the number of points a player starts off with when they join the server. It is recommended to give the players a fair number of free points so they have a bit of a starter boots.

# World to display the scoreboard and prevent block breaking
hub-world: world

THIS IS VERY IMPORTANT!!

This is the WORLD (as in world folder in Bukkit) that will be auto-set up for a SG lobby. If you want to have an only-SG-server, you can leave this selected as 'world' (unless you have changed your default world's name). There are many reasons why you might want to change this. If your server is not SG-only, you will not want the lobby world interfering with your main lobby. The lobby world:

  • Adds double jump
  • Adds potion effects
  • Uses both the Sidebar and Tablist scoreboard slots
  • Prevents default block breaking
  • Displays a boss bar
  • Displays the SG welcome message upon entering
  • Some other minor stuff

If you want to change the default world, you will have to use another Multiworld plugin (I recommend Multiverse) to create/manage the world, as SG does not provide a lobby world.

# Welcome message
welcome-message:
    - &cSome
    - &2Messages
    - &4Here

These messages are displayed upon the player entering the SG hub world. If the hub world is the default world, they will display on player login.

# Please enter acceptable item names, which can be found in http://jd.bukkit.org/rb/apidocs/org/bukkit/Material.html
breaks-allowed:
  - 'SOME'
  - 'BREAKABLE'
  - 'BLOCKS'
  - 'HERE'
  - 'USING'
  - 'REAL'
  - 'BLOCK/ITEM'
  - 'NAMES'

This is the list of blocks that can be broken in a SG map. The block will rollback at the end of a game, but they will not rollback if the server is shutdown in a game, so it is recommended that you /end all arenas before shutting down your server. It is _crucial _ that you use 'real item names' which means the case sensitive names copied exactly as they appear from this list.

That's the end of the config file (you made it)!

You can now [links coming]:

Clone this wiki locally