version-1-0

UHC Team Builder

1.0

This mod was designed to work with the bukkit UltradHardcore mod by ghowden. Even though the feature set has been designed around this mod there is no requirement to actually use UHC Team Builder with that mod.

This mod is to help admins and players work with teams, a common theme to UHC team matches is the struggle to get effective, consistent and reliable method to create the teams. Even with functionality seen in snapshots for 1.6, this still has not been achieved. So what does this mod do, it allows you to create random or predefined teams for your matches with very easy setup.

This will also allow your users to name there teams, adding there teams personality to the rest of the game, it is fun hearing the names of the teams in Mindcrack's UHC, Team Uppercat is a great example; however only their team knows and references the team name.

Commands

Only players can submit commands, the console is unable to use these commands.

TeamBuilder

This command will be able to build and group teams together based on the command given. It will also allow you to save the current team file to allow you to use it for a rematch. (This will override any team.yml configuration you have set). This command is meant to be run after you have scattered your players. Scatter all your players, then run TeamBuilder this will group all the players to one of their scattered location.

/TeamBuilder <command> <args>

Command Arguments:

  • random, will create teams based on the team size you set
    • Args: [team size #]
    • Example: /TeamBuilder random 4
  • file, will create teams based on the team.yml you have configured in your UHC Team Builder plugin config folder
    • Args: there are none
    • Example: /TeamBuilder file
  • save, will save your current team set in the team.yml file to be used later.
    • Args: there are none
    • Example: /TeamBuilder save

TeamName

Any player can use this command to change the team name of the current team they are on. I recommend a team name under 8 characters as longer prefixes can cause formatting issues on the main scoreboard. There is a hard cap of 14 characters. Players can only change there team name. There is a conflict with UHC 2.4.1 that prevents the team prefix from showing up in the main scoreboard.

/TeamName <Team Name>

OpTeamName

This will allow a user to override a team name, you just need to specify a player name on that team and it will set the team's name. Recommendation and hard caps for team name size are the same as the TeamName command.

/OpTeamName <player> <name>

UTBConfig

This command at this time only allows you to reload the config.yml file. This is useful if you have a lot of mods setup and you only want to update the permissions given to each user to run commands.

/UTBConfig reload

Configuration

This section will go through modifying and utilizing the configuration files in the plugin.

config.yml

The config.yml will drive the permissions for running commands for the plugin. The first level of each section should be the command you are trying to apply permissions to. Under each section there should be a level parameter that will determine the permissions you want to set, below is a list of levels available. There is an optional parameter users, which is a list of users that is used by mixed and userlise

Levels:

  • everyone
    • Everyone can run this command
  • op
    • Only ops can run this command
  • userlist
    • Only users specified can run this command
  • mixed
    • Both users listed and ops can run this command

example:

teambuilder:
  level: userlist
  users:
    - user1
    - user2
teamname:
  level: everyone
opteamname:
  level: op
utbconfig:
  level: op

team.yml

The team.yml will allow you to pre-define teams before a match. Make sure to backup these files, TeamBuilder will save over any information that is stored in this file. The first parameter will be teams, this will state how many team sections will follow. After teams, there will be a series of team# sections that follow (starting with team1) each section will have a parameter for both the name of the team and the players associated to that team. Below is an example of the the team.yml configuration file.

example:

teams: 2
team1:
  name: B-Team
  players: 
    - Player1
    - Player2
    - Player3
team2:
  name: A-Team
  players: 
    - Player4
    - Player5
    - Player6

Documentation Archive

Version 0.8.5Version 1.0Version 1.4 (Documentation Preview)