-
Notifications
You must be signed in to change notification settings - Fork 2
Home
RankCapes is a Bukkit plugin and Minecraft client mod combo that allows server owners to give their players custom capes based on permissions. RankCapes is easy to setup and use. It supports regular, animated, and HD capes!
- Make you own capes for server players!
- Multiple capes per player!
- Animated capes!
- HD Cape support!
- Cape Packs, similar to Resource Packs, for easy swapping!
- Bukkit permission-based cape access system!
##Contents
###About RankCapes was made for servers that would like to offer something more to their players. Originally dubbed "DonorCapes", Jadar coded an experimental version that was very sketchy and not very flexible. Now Jadar has coded from the ground up this brand new plugin/mod combo that is a fun aesthetic mod that allows servers to give their players capes based on permissions given to them. RankCapes is not restricted to donating or contributing players, though; anyone can be given a cape, as anyone can be given a permission. Easy to use, RankCapes implements Cape Packs that are like Resource Packs and can be swapped back and forth easily. ###Parts RankCapes is broken up into multiple parts. There are the two types of capes: [Animated](./wiki/Animated-Cape) and [Static](./wiki/Static-Cape). Then there's the [Permissions](./wiki/Permissions) that give players access to the capes. And finally there are the server and client sides of RankCapes: Bukkit plugin and [Client Mod](./wiki/RankCapes-Client-Mod). ###How it Works On the server there is a [Cape Pack](./wiki/Cape-Pack) that contains all the textures as well as a file that associates images and cape names. Capes are given with this permission node: `rankcapes.cape.use.CAPE_NAME`. When clients with the mod installed connect to the server, they can change their cape to whatever they have permissions for in the cape change GUI. All other players with the mod installed can see theirs, and other player's capes. ###Plugin Setup Server-side plugin setup is easy. First you need to create or obtain a cape pack, secondly configure the plugin, third give players permissions. Details are given below.
#####- Setting up the Cape Pack. If you're using an existing cape pack, skip ahead to the next paragraph.
A Cape Pack consists of images and a pack.mcmeta file. Create or obtain the images to be used as the cape textures. These may have larger dimensions but must comply with the dimension requirements. Once you have your images, put them in a ZIP file. You may organize them into folders if you would like. Next create a pack.mcmeta file as described here. This file tells RankCapes a cape name and an image associated to that cape name. It's also used for assembling Animated Capes.
Once you have a Cape Pack move it into the RankCapes plugin directory.
#####- Setting up plugin configuration. The RankCapes plugin config file is simple. In it the Cape Pack file name is given as well as a port. The port is used to establish a separate connection, other than the Minecraft one, to the client. The Cape Pack is sent over this separate connection.
#####- Give players access to capes. Access to capes is given by the permissions assigned to a player. They may be player specific or part of the rank, or group, the player is assigned to. There are a few different permission management plugins out there, RankCapes should work with all of them. The permission node that gives access to a cape is this.
rankcapes.cape.use.$CAPE_NAME
Where $CAPE_NAME is the name of a cape given in the Cape Pack pack.mcmeta.
If you want to give full access to all capes, replace $CAPE_NAME with a wildcard (*) symbol .
rankcapes.cape.use.*