Bukkit

Ultimate Games

The ULTIMATE Mini-game Engine!

Try it out! Visit server.thebigdigmc.info

Latest version: 1.0. Compatible with Craftbukkit 1.6.2 - 1.6.4, previous versions untested.

• Download
• Dev Builds Development builds of this project can be acquired at the provided continuous integration server. These builds have bugs, are not official releases, and have not been approved by the BukkitDev staff. Use them at your own risk.
• Found a bug? Have a suggestion?
• Github - Main Plugin Source Here!
• Games Source Here!
• Web Chat

What is Ultimate Games?

Ultimate Games is a mini-game engine created by ampayne2 and greatman321. It handles everything a mini-game needs to do, and handles as many games/arenas at once as you like. It greatly simplifies developing custom mini-games as you can focus on the mini-game's actual mechanics instead of creating a whole mini-game management system from scratch. You can make a simple mini-game in a very short amount of time, or use the powerful features available to create a more complex mini-game.

UG is an open source plugin and comes with 5 fully functional games (also open source) to demonstrate how the plugin works and how to use the engine to create a mini-game. If you are not a developer, but are simply looking for mini-games to put on your server, look no further! You can play the 5 fun included mini-games, or find a developer that is willing to code one for you! We may be including more mini-games with the plugin in the future.

• Contact ampayne2 if you wish to request a custom private minigame using the UG engine.

Features:

• Join/leave/spectate minigames.
• Lobby signs, Redstone input/output signs, Text output signs, Click input signs.
• Chests with configurable specific or random contents.
• Queues.
• Instruction books.
• Player name colors.
• Teams.
• Classes.
• Streaks.
• Special Game Items.
• Game sounds and particle effects.
• Arena rollback.
• Scoreboards
• Countdowns
• Safe to use on a survival server (no exploits to get stuff out of games etc).
• Live game stats with the web API.
• Whitelist or Blacklist different blocks and actions inside arenas.
• Metrics with several custom graphs! http://mcstats.org/plugin/UltimateGames
• Integrates into other plugins to avoid interference. (If any plugin interferes with UG, let us know! We'll add support for it)
• Lots of custom events to integrate into your own plugin if needed.
• Much more!

In Progress:

• Finish chests
• Redo arena resetting

Existing Minigames:

Included:

• Deathmatch
• Team Deathmatch
• Capture The Flag (Not included in the beta release of UG, the arena reset code is being redone.)
• Tag - GamePlay Demonstration!
• Fish slap

Not included:

• Spleef
• Hunter

Installation:

1. Place the UltimateGames jar file inside /plugins, and restart your server to generate its config files and folders.
2. Optional: Edit the config.yml to use a MySQL database instead of sqlite.
3. Place the jars of any games you want to use in /plugins/UltimateGames/Games, and restart your server to load them and generate their configs.
4. Go ingame, stand where you want the lobby to be set, and type /ug setlobby

Setting up an arena:

• Type /ug arena create [arena name] [game name] and select a rectangular region for the arena.
• Setup spawnpoints for your arena by typing /ug arena addspawn [arena name] [game name] [locked] at every location you want a spawnpoint.
• Setup a spectator spawnpoint for your arena by typing /ug arena setspectatorspawn [arena name] [game name] at a location in the arena.
• Place a sign in your lobby and type the following on its lines:

Line 1: [ug lsign] (This line may be different if you changed it in the config.yml)

Line 2: Your game's exact name.

Line 3: Your arena's exact name.

Line 4: Leave this line blank.

• Type the command /ug arena open [arena name] [game name] to open your newly created arena to your server!
• NOTE: Game-Specific setup instructions can be found in a game's config (/plugins/UltimateGames/Games/gamename.yml).

Commands:

• /ug arena addspawn [arena name] [game name] [locked (locks a player to the spawnpoint until arena begins. true/false)]
• Permission: ultimategames.arena.addspawn

• /ug arena begin [arena name] [game name] [locked] (Used to force start an arena)
• Permission: ultimategames.arena.begin

• /ug arena create [arena name] [game name] (Used to create an arena)
• Permission: ultimategames.arena.create

• /ug arena edit (Used to edit an arena. Must join the arena before you can edit it)
• Permission: ultimategames.arena.edit

• /ug arena end [arena name] [game name] (Used to force end an arena)
• Permission: ultimategames.arena.end

• /ug arena join [arena name] [game name] (Used to join an arena)
• Permission: ultimategames.arena.join

• /ug leave (Used to leave an arena)
• Permission: ultimategames.arena.leave

• /ug arena open [arena name] [game name] (Used to open an arena)
• Permission: ultimategames.arena.open

• /ug arena stop [arena name] [game name] (Used to stop an arena. Players will not be able to join until it is re-opened)
• Permission: ultimategames.arena.stop

• /ug arena spectate [arena name] [game name] (Used to spectate an arena)
• Permission: ultimategames.arena.spectate

• /ug setlobby (Used to set the UG lobby)
• Permission: ultimategames.setlobby

• /ug cmd [command] (Used to override the command blocker)
• Permission: ultimategames.extcmd

• NOTE: Some games have their own commands. They are listed in the game's instruction book.
• NOTE: While inside an arena, all non-ug commands are blocked. Type /ug cmd [command] to use a non-ug command.

Developers:

• Extend the GamePlugin class and simply override the methods, adding your functionality to create a game!
• Create a yml file to contain all your game's required settings, custom settings, custom messages, and instructions
• Let Ultimate Games take care of all the work! There is a manager for everything you would need.
• Contact ampayne2 or greatman321 if you want to help out! We are usually in #UltimateGames on esper irc, or you can send a PM.

Game example : Tag