Skip to content

TheBrunoRM/Skywars

Repository files navigation

Skywars

A Minecraft plugin that adds the Skywars minigame. Compatible with Bukkit and Spigot, from versions 1.8 upwards.

Codacy Badge GitHub last commit version view on SpigotMC

Table of Contents

  1. How to install
  2. How to use
  3. Current features
  4. To do
  5. Compatibility issues

How to install

To install the plugin, drag the .jar file to your server's plugins folder.
The plugin does not need any other dependencies as it should work by itself.
You can start or reload the server after installing the plugin.

How to use

Type /sw help to see the available commands.
Add maps into the "worlds" folder; the plugin will
load the worlds and create the configuration files for their maps.

To disable the default lobby scoreboard,
set the value of lobby in the scoreboard.yml file to false.

If the plugin doesn't have a main lobby set,
players will be teleported to the last location they were at.
If it is set, then they will be teleported to it.

How to play

Type /sw play to open the arenas menu and click an arena to join.
Type /sw start to start the game countdown.
Type /sw forcestart to start the game immediately.

Creating an arena

To create an arena, type /sw create
After creating the arena, type /sw config to open the configuration menu
You can configure most of the values of the arena on the configuration menu,
and for the ones you can't find, you can refer to the arena's configuration file.
Make sure to select a world folder.
To load an world folder, put it inside the worlds folder inside the plugin folder
You can set the arena's world through the configuration menu

Creating signs

To create a sign, make it like this:

  • 2nd line: [SkyWars]
  • 3rd line: the arena name.

* The casing of the signs is not relevant; there cannot be two arenas with the same name but different casing.

Sign image

To remove a sign, sneak (shift) while on creative mode and left click.

Plugin hooks

The plugin will hook to other plugins to add extra functionality.

Economy

Current economy features:

  • Coins

Currently implemented economy plugin APIS (Skywars.java):

  • Vault

Holograms

Current hologram features:

  • Holograms above chests to indicate refill time.

Currently implemented hologram plugins APIs (HologramController.java):

  • HolographicDisplays
  • DecentHolograms

Current features

  • Maps
  • Kits
  • Easy map setup menu
  • Custom language file (not 100% of the messages, still working on it)
  • Configuration options
  • Chest refills
  • 1.13 compatible (still working on it, but it kinda works)
  • Vault support (economy)

To do

  • More game events
  • More configuration options
  • Party options (?)
  • Team games
  • Custom cases (schematic)
  • Ability to buy kits (inside and outside a game)
  • Ability to change case (inside and outside a game)
  • Game options (time, weather, chests, etc)
  • Code optimization
  • Plugin API events and methods

Compatibility issues

  • Schematic files
    The plugin no longer works with schematic files.
    I've decided to drop support for these type of files
    for various reasons like compatibility.
    I may consider implementing a new system for this.
    For now, the plugin works with world files.
  • Actionbar messages on Bukkit
    do not work because of Bukkit limitations on message sending.
    If you find a way to send an actionbar message on Bukkit, please open an issue or a pull request.

Contact me in Discord: brunorm