-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
585053c
commit 0376711
Showing
10 changed files
with
354 additions
and
273 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,113 @@ | ||
| # Skywars | ||
|
|
||
| A Minecraft plugin that adds the Skywars minigame. | ||
| Compatible with Bukkit and Spigot, from versions 1.8 upwards. | ||
|
|
||
| [](https://www.codacy.com/gh/TheBrunoRM/Skywars/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TheBrunoRM/Skywars&utm_campaign=Badge_Grade) | ||
| [](https://github.com/TheBrunoRM/Skywars/commits/master) | ||
| [](https://github.com/TheBrunoRM/Skywars/releases/latest) | ||
| [](https://www.spigotmc.org/resources/98709) | ||
|
|
||
| # Table of Contents | ||
| 1. [How to install](#how-to-install) | ||
| 2. [How to use](#how-to-use) | ||
| * [How to play](#how-to-play) | ||
| * [Creating an arena](#creating-an-arena) | ||
| * [Creating signs](#creating-signs) | ||
| 3. [Current features](#current-features) | ||
| 4. [To do](#to-do) | ||
| 5. [Compatibility issues](#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.\ | ||
| The plugin comes with a default arena and kit,\ | ||
| so you should be able to play right after installing the plugin. | ||
|
|
||
| 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 <arena>**\ | ||
| After creating the arena, type **/sw config <arena>** to open the configuration menu\ | ||
| You can configurate most of the values of the arena on the configuration menu\ | ||
| Make sure to select an **schematic** file\ | ||
| To load an schematic file, put it inside the **schematics** folder inside the plugin folder\ | ||
| You can set the arena's schematic through the configuration menu | ||
|
|
||
| ### Creating signs | ||
|
|
||
| To create a sign, make it like this: | ||
|
|
||
|  | ||
|
|
||
| ## 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](https://github.com/TheBrunoRM/Skywars/blob/master/src/main/java/me/brunorm/skywars/Skywars.java#L250)): | ||
| * Vault | ||
| ### Holograms | ||
| #### Current hologram features: | ||
| * Holograms above chests to indicate refill time. | ||
|
|
||
| #### Currently implemented hologram plugins APIs ([HologramController.java](https://github.com/TheBrunoRM/Skywars/blob/master/src/main/java/me/brunorm/skywars/holograms/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 currently works with both .schematic and .schem file types,\ | ||
| but there are some problems with some block types and metadata, like with chests. | ||
| If you find any way to improve it, you're welcome to help! | ||
| * **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#7316 | ||
| # Skywars | ||
|
|
||
| A Minecraft plugin that adds the Skywars minigame. | ||
| Compatible with Bukkit and Spigot, from versions 1.8 upwards. | ||
|
|
||
| [](https://www.codacy.com/gh/TheBrunoRM/Skywars/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TheBrunoRM/Skywars&utm_campaign=Badge_Grade) | ||
| [](https://github.com/TheBrunoRM/Skywars/commits/master) | ||
| [](https://github.com/TheBrunoRM/Skywars/releases/latest) | ||
| [](https://www.spigotmc.org/resources/98709) | ||
|
|
||
| # Table of Contents | ||
| 1. [How to install](#how-to-install) | ||
| 2. [How to use](#how-to-use) | ||
| * [How to play](#how-to-play) | ||
| * [Creating an arena](#creating-an-arena) | ||
| * [Creating signs](#creating-signs) | ||
| 3. [Current features](#current-features) | ||
| 4. [To do](#to-do) | ||
| 5. [Compatibility issues](#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.\ | ||
| The plugin comes with a default arena and kit,\ | ||
| so you should be able to play right after installing the plugin. | ||
|
|
||
| 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 <arena>**\ | ||
| After creating the arena, type **/sw config <arena>** to open the configuration menu\ | ||
| You can configurate most of the values of the arena on the configuration menu\ | ||
| Make sure to select an **schematic** file\ | ||
| To load an schematic file, put it inside the **schematics** folder inside the plugin folder\ | ||
| You can set the arena's schematic through the configuration menu | ||
|
|
||
| ### Creating signs | ||
|
|
||
| To create a sign, make it like this: | ||
| * 2nd line: [SkyWars] | ||
| * 3rd line: the arena name. | ||
|
|
||
| \* The signs are case insensitive, they get parsed and properly formatted after. | ||
|
|
||
|  | ||
|
|
||
| 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](https://github.com/TheBrunoRM/Skywars/blob/master/src/main/java/me/brunorm/skywars/Skywars.java#L250)): | ||
| * Vault | ||
| ### Holograms | ||
| #### Current hologram features: | ||
| * Holograms above chests to indicate refill time. | ||
|
|
||
| #### Currently implemented hologram plugins APIs ([HologramController.java](https://github.com/TheBrunoRM/Skywars/blob/master/src/main/java/me/brunorm/skywars/holograms/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 currently works with both .schematic and .schem file types,\ | ||
| but there are some problems with some block types and metadata, like with chests. | ||
| If you find any way to improve it, you're welcome to help! | ||
| * **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#7316 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,35 @@ | ||
| package me.brunorm.skywars; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.bukkit.Material; | ||
| import org.bukkit.inventory.Inventory; | ||
| import org.bukkit.inventory.ItemStack; | ||
| import org.bukkit.inventory.meta.ItemMeta; | ||
|
|
||
| public class InventoryUtils { | ||
|
|
||
| public static Inventory addItem(Inventory inventory, ItemStack item, int slot, String displayName, | ||
| String... loreLines) { | ||
| try { | ||
| final ItemMeta meta = item.getItemMeta(); | ||
| meta.setDisplayName(Messager.color(displayName)); | ||
| final List<String> lore = new ArrayList<String>(); | ||
| for (final String line : loreLines) | ||
| lore.add(Messager.color("&e" + line)); | ||
| meta.setLore(lore); | ||
| item.setItemMeta(meta); | ||
| inventory.setItem(slot, item); | ||
| } catch (final Exception e) { | ||
| e.printStackTrace(); | ||
| Skywars.get().sendDebugMessage("Could not set item for inventory."); | ||
| } | ||
| return inventory; | ||
| } | ||
|
|
||
| public static Inventory addItem(Inventory inventory, ItemStack item, int slot, String displayName) { | ||
| return addItem(inventory, item, slot, displayName); | ||
| } | ||
|
|
||
| public static Inventory addItem(Inventory inventory, Material material, int slot, String displayName, | ||
| String... loreLines) { | ||
| return addItem(inventory, new ItemStack(material), slot, displayName, loreLines); | ||
| } | ||
| } | ||
| package me.brunorm.skywars; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.bukkit.Material; | ||
| import org.bukkit.inventory.Inventory; | ||
| import org.bukkit.inventory.ItemStack; | ||
| import org.bukkit.inventory.meta.ItemMeta; | ||
|
|
||
| public class InventoryUtils { | ||
|
|
||
| public static Inventory addItem(Inventory inventory, ItemStack item, int slot, String displayName, | ||
| String... loreLines) { | ||
| try { | ||
| final ItemMeta meta = item.getItemMeta(); | ||
| meta.setDisplayName(Messager.color(displayName)); | ||
| final List<String> lore = new ArrayList<String>(); | ||
| for (final String line : loreLines) | ||
| lore.add(Messager.color("&e" + line)); | ||
| meta.setLore(lore); | ||
| item.setItemMeta(meta); | ||
| inventory.setItem(slot, item); | ||
| } catch (final Exception e) { | ||
| e.printStackTrace(); | ||
| Skywars.get().sendDebugMessage("Could not set item for inventory."); | ||
| } | ||
| return inventory; | ||
| } | ||
|
|
||
| public static Inventory addItem(Inventory inventory, Material material, int slot, String displayName, | ||
| String... loreLines) { | ||
| return addItem(inventory, new ItemStack(material), slot, displayName, loreLines); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.