ProjectKorra Official Wiki¶
Welcome to the ProjectKorra Wiki, the official source of information for all things relating to ProjectKorra.
Info¶
This wiki is maintained by the Digital Team. We encourage all users to report any issues they may find on our GitHub
Below is a directory containing all of the pages in this Wiki. Contents are divided topically (General refers to miscellaneous ProjectKorra information, Core refers to ProjectKorra Core information, etc).
About ProjectKorra¶
ProjectKorra is an organization, established by MistPhizzle in June 2014, to continue maintaining a completely open source version of Orion304’s original Minecraft: The Last Airbender plugin for Bukkit. ProjectKorra’s purpose is to bring the Avatar: The Last Airbender and Avatar: The Legend of Korra universe into Minecraft, giving player an opportunity to experience the show in a new light.
Contributing¶
Here you can find information on how you can contribute to ProjectKorra. Although joining the team is the best way to contribute, below you can find information how to contribute as a community member!
Useful Links¶
- Visit our Website, where you can find our forums, downloads, and the most recent community bulletin.
- Join our Discord server! There you can get help from developers, post suggestions, and chat with community members!
- Follow our Twitter for all the latest news!
- Go to our GitHub to see all the latest developments and updates!
FAQ¶
Who runs ProjectKorra?¶
ProjectKorra relies on a volunteer staff team composed of many different teams: developers, digital media, moderators, and server staff. In addition, ProjectKorra heavily relies on its community and would not be successful without it.
How can I get involved with ProjectKorra?¶
Absolutely anyone can become involved with ProjectKorra. Apply by clicking here to go to our staff applications!
How can I report a bug?¶
We encourage all bugs, big and small, be reported in the proper bug report section of the forum. Please report bugs here in the corresponding category and they will be fixed ASAP.
Note
Bugs reported for earlier versions of a plugin may have already been fixed. Please verify that bugs reported are for the latest version of the plugin you are using.
How can I suggest a feature?¶
We encourage members to make suggestions! Suggestions do not need to be based off of something you had seen in the show, but they should remain practical. You can make suggestions by clicking here to go to our forums. Please ensure that your suggestion is not a duplicate of another already posted!
Where can I download ProjectKorra?¶
The latest release of ProjectKorra is 1.9.0, which is compatible with Spigot 1.16. You can download it here.
Does ProjectKorra work for X version?¶
ProjectKorra’s latest release, 1.9.0, was designed for Spigot 1.16. If you installed it on a different version of Spigot, the plugin would not be guaranteed to work properly. Using ProjectKorra with versions other than the ones stated above is not recommended.
How do I install ProjectKorra on my server?¶
First, download ProjectKorra from the link above. Then, place the .jar file you downloaded into your server’s “plugins” folder. Finally, restart your server.
How do I get the bending sideboard that shows my bound abilities?¶
ProjectKorra currently doesn’t come with a bending sideboard. You’d have to install a side plugin for this. The well-known side plugins JedCore and ProjectAddons come with bending boards, but they also include a myriad of addon abilities. The download links for both side plugins can be found below; to install them you’d download the .jar file and put it in your server’s “plugins” folder.
Note
These side plugins are addons and are not maintained by ProjectKorra, and ProjectKorra developers may not be able to offer support with them.
JedCore download for Minecraft 1.15/1.14 ProjectAddons download for Minecraft 1.16
How do I use ProjectKorra on singleplayer?¶
ProjectKorra is a Spigot plugin, and plugins are intended for multiplayer servers. You can either try the Avatar Mod 2, which is not the same as ProjectKorra, or you could make your own multiplayer server, install ProjectKorra, and just not portforward or tell others about it, basically making it a singleplayer experience. You can download the Avatar Mod 2 here.
Available Downloads¶
The ProjectKorra team has several resources, these are the ones available to download.
Plugins¶
Addons and Side Plugins¶
There are plenty of addons and side plugins released by community members. All publicly released ones can be found on our website!
Note
The ProjectKorra team cannot provide help for unofficial resources, but can assist in finding who to contact if a problem arises.
Mods¶
- Avatar Mod 2: Out of the Iceberg (alpha 1.5.17 for Forge 1.12)
ProjectKorra Team¶
The ProjectKorra team is comprised of volunteers who work on various aspects of the plugin! Many of these volunteers are developers, but there are several other positions!
Meet the Team¶
Administrators¶
Admins are responsible for the day to day operations of ProjectKorra.
| Member | Position | MC Avatar |
| MistPhizzle | Admin & Founder | |
| OmniCypher | Project Lead |
Development Team¶
The Development Team is the backbone of ProjectKorra. Their main responsibilities include maintaining our projects’ code and responding to bug-reports.
If you want to become a developer, click the link below to apply.
Lead Developers¶
| Sobki | Lead Developer |
Developers¶
| AlexTheCoder | Developer | |
| Coolade | Developer | |
| Finn_Bueno_ | Developer | |
| Jacklin213 | Developer | |
| plasmarob | Developer | |
| Simplicitee | Developer | |
| StrangeOne101 | Developer | |
| Varhagna | Developer |
Junior Developers¶
Junior Developers are developers in training. They help out where they can and work on expanding their skills to eventually become developers
Mod Developers¶
Mod Developers work on the modded side of ProjectKorra. They are responsible for maintaining Avatar Mod 2: Out of the Iceberg, which you can find here.
| FavouriteDragon | Forge Developer | |
| Mahtaran | Forge Developer | |
| Mnesikos | Forge Developer |
Bug Testers¶
Bug testers work on quality assurance. They are the ones who vigourously test ProjectKorra plugins to make sure they are usuable.
| TheWaterChief | Bug Tester |
Digital Team¶
The Digital Team focuses making ProjectKorra look good. Their main responsibilities include making videos, maintaining our wiki, and managing social media.
If you want to join the digital team, click the link below to apply
Maintainers¶
| Jacksonnn | Wiki Maintainer |
Contributing to the Wiki¶
Setting Up the Environment¶
To begin editing the Wiki, you first need to your environment. `Python`_ is the only dependency required.
Note
When installing Python make sure to tick the Add Python to PATH option to be able to use python within your terminal/command prompt
- Fork the GitHub repository and clone it.
Note
Remember to replace YOUR_USERNAME with your GitHub username.
git clone https://github.com/YOUR_USERNAME/ProjectKorraWiki.git
The wiki is built with Sphinx using the sphinx_rtd_theme from ReadTheDocs. Navigate to the directory you cloned the project to, then it will install all the requirements by running the following command in terminal / command prompt.
pip install -r .\requirements.txt
This should install both Sphinx as well as the theme.
To check that Sphinx is correctly installed, run:
sphinx-build -version
If Sphinx has been installed correctly, it should output sphinx-build and the version number. (ex. sphinx-build 1.7.5)
Sphinx is required to view your changes locally before submitting them.
Viewing Local Changes¶
Once you have made some changes and are ready to see your edits locally, open terminal / command prompt and run
.\make.bat html
This should build an HTML version of the wiki in the build folder (“buildhtmlindex.html”) in the root directory of your repository under the html folder.
Submitting Changes¶
Now that you are happy with your changes remember to commit them using git and make sure to put a detailed message indicating what you have done. If you are working on an issue, please include a link to the corresponding GitHub Issue / Trello Card in your commit description.
You are now ready to make a pull request which you can create here.
Remember to compare across forks as shown in the screenshot below
Once you are ready and content with your changes hit the Create pull request button and fill out the template with the corresponding information.
Your changes will be reviewed and then merged by the Wiki Team. They may request changes and delay merging if they find any errors.
About Core¶
ProjectKorra Core is an open source Spigot plugin, created by MistPhizzle in June 2014, based on Orion’s original Minecraft: The Last Airbender plugin for Bukkit. ProjectKorra’s purpose is to bring the Avatar: The Last Airbender and Avatar: The Legend of Korra universe into Minecraft, allowing players to choose between the skills shown in the show: Firebending, Airbending, Waterbending, Earthbending, or Chiblocking.
Features¶
ProjectKorra Core is the central plugin used to bring mechanics from the Avatar universe into Minecraft. As stated above, players can choose from 5 paths: Fire, Air, Water, Earth, or Chi. Each of the paths has its own playstyle, so it’s up to the player to find the one that best suits them.
Elements¶
- Air is the element of freedom. Airbenders are quick, agile, and passive in nature, preferring to bob and weave through flurries of attacks, and defending if they have no other option.
- Fire is the element of power. Firebenders are very aggressive and powerful, choosing to overwhelm their opponents with an endless onslaught of offensive attacks instead of being defensive.
- Earth is the element of substance. Earthbenders stay rooted to the ground, preferring to face opponents head-on, using a mix of defensive and offensive strategies to crush their foes.
- Water is the element of change. Waterbenders use their plethora of skills to redirect and manipulate opponents attacks against them. Similar to Earthbenders, they employ both defensive and offensive strategies to accomplish this.
- Chi is the anti-bending fighting style. Chiblockers use well placed blows to temporarily disable their opponents bending, leaving them virtually defenseless.
ProjectKorra API¶
Developers can also use our extensive API to create addon abilities and side plugins that hook into ProjectKorra Core.
Commands and Permissions¶
This page contains all of the commands and permissions in ProjectKorra Core.
Note
Last updated for v1.8.8
Commands¶
The base command for the ProjectKorra plugin is /projectkorra. Aliases for this
command are /bending, /b, /bend, /tla, /mtla, /korra, /pk.
Tip
The /projectkorra command is more commonly known as /bending and will be referred to below by that alias.
Note
All commands are actually subcommands of /bending, where one would
do /bending <subcommand> to perform a function. (i.e /bending help)
<> - mandatory[] - optionalAdd¶
/bending add <element> <player>[a]Adds the specified <element> to the target <player>.
| Permissions | ||
| bending.command.add | allows use of command | default |
| bending.command.add.others | allows adding elements to other players | op |
| bending.command.add.<element> | allows adding of a specific element | default |
Bind¶
/bending bind <ability> [1-9][b]Binds the <ability> to the selected slot [1-9] or the held item slot if not given.
| Permissions | ||
| bending.command.bind | allows use of command | default |
Check¶
/bending check[chk]Checks if the the server is running the latest version of ProjectKorra Core.
| Permissions | ||
| bending.command.check | allows use of command | default |
Choose¶
/bending choose [player] <element>[ch]Changes the player’s element to the given element. If the player has multiple elements, they are removed before setting the new element.
| Permissions | ||
| bending.command.choose | allows use of command | default |
| bending.command.choose.<element> | allows choosing for a specific element | default |
| bending.command.rechoose | allows players to change their element | op |
| bending.admin.choose | allows choosing elements for others | op |
Clear¶
/bending clear[c, cl]Clears the user’s binds.
| Permissions | ||
| bending.command.clear | allows use of command | default |
Copy¶
/bending copy <player> [player][co]Copies another player’s binds to the targeted player or the user if not given.
| Permissions | ||
| bending.command.copy | allows use of command | default |
| bending.command.copy.assign | allows copying to other player’s binds | op |
Debug¶
/bending debug[de]Creates a debug file in the ProjectKorra folder to be given with a bug report.
| Permissions | ||
| bending.command.debug | allows use of command | default |
Display¶
/bending display [(sub)element][d, dis]Displays the user’s binds or the abilities in the given element.
| Permissions | ||
| bending.command.display | allows use of command | default |
Help¶
/bending help [topic][h]Shows the help for a given ability, element, command, or other feature of the plugin, or lists all bending commands if not given a topic.
| Permissions | ||
| bending.command.help | allows use of command | default |
Invincible¶
/bending invincible[i, inv]Makes the user invincible to bending effects.
| Permissions | ||
| bending.command.invincible | allows use of command | op |
Permaremove¶
/bending permaremove <player>[pr, premove, permremove]Permanently removes the bending of <player>. Can be reversed by doing the command on them again.
| Permissions | ||
| bending.admin.permaremove | allows use of command | op |
Preset¶
/bending preset [list / create / delete / bind] [name] [player][p, pre, set, presets]Base preset command, allows for creating, deleting, or binding a preset if given a name, or listing them.
| Permissions | ||
| bending.command.preset | allows use of command | default |
| bending.command.preset.list | allows listing of user’s presets | default |
| bending.command.preset.create | allows creating new presets | default |
| bending.command.preset.create.# | allows player to have # of presets (5) | default |
| bending.command.preset.delete | allows deleting existing presets | default |
| bending.command.preset.bind | allows binding of presets | default |
| bending.command.preset.bind.assign | allows binding presets to other players | op |
| bending.command.preset.bind.external | allows binding of global presets | op |
| bending.command.preset.bind.external.other | allows binding presets of other players | op |
Reload¶
/bending reload[r]Reloads ProjectKorra Core and all side plugins.
| Permissions | ||
| bending.admin.reload | allows use of command | op |
Remove¶
/bending remove <player> [element][rm]Removes all of the elements from the <player> or solely [element].
| Permissions | ||
| bending.admin.remove | allows use of command | op |
Stats¶
/bending <get / leaderboard> <ability / element / all> <statistic> [player / page][statistics]Command for viewing various stats on the server. They can be searched per player or by the leaderboard, which will show everyone’s stats for the given type. Stats are also dependent on whether you want a specific ability, element, or all of them.
| Statistics |
| PlayerKills |
| PlayerDamage |
| TotalKills |
| TotalDamage |
Toggle¶
/bending toggle [element / player / all][t]Toggles the selected element or bending overall of the targeted player or all players, and toggles bending for self if no argument is given.
| Permissions | ||
| bending.command.toggle | allows use of command | default |
| bending.command.toggle.all | allows toggling of all bending | op |
| bending.admin.toggle | allows toggling other players | op |
Version¶
/bending version[v]Displays the versions of ProjectKorra plugins installed on the server.
| Permissions | ||
| bending.command.version | allows use of command | default |
Who¶
/bending who [player][w]Displays detailed bending info about the given player, or lists all online players and their elements.
| Permissions | ||
| bending.command.who | allows use of command | default |
Permissions¶
The following table represents all other permissions in ProjectKorra Core.
To give or take permissions you can either define them in your permissions.yml or use a permissions plugin (i.e PermissionsEx or GroupManager).
In the absence of a permissions plugin, permissions marked default will be available to everyone whereas permissions designated as op will only be available to operators.
Note
Certain abilities and subelements (namely AvatarState, Bloodbending, and Flight) can only be used by opped players by default.
| Permission | Description | Default |
| bending.player | Allows access to most of the plugin’s features | true |
| bending.admin | Allows access to administrative features | op |
| bending.admin.<command> | Allows access to an administrative command | op |
| bending.avatar | Gives the avatar color in chat | false |
| bending.<element> | Allows access to <element> | true |
| bending.<element>.passive | Allows access to <element> passives | false |
| bending.<element>.<subelement> | Allows access to <subelement> of <element> | varies |
| bending.ability.<ability> | Allows usage of <ability> | varies |
| bending.donor | Shows the player as a donor in the who command | false |
| bending.command.<command> | Allows usage of <command> | varies |
| bending.command.rechoose | Allows the player to rechoose their element | false |
| bending.message.daymessage | Allows the player to see the day message | true |
| bending.message.nightmessage | Allows the player to see the night message | true |
Elements and Abilities¶
Each element has a variety of abilities that can be used for combat, exploration, and gathering resources. Below are outlines of each element and the abilities they contain.
Airbending¶
Air is the element of freedom. Airbenders are quick, agile, and passive in nature, preferring to bob and weave through flurries of attacks, and defending if they have no other option.
Airbending abilities focus on mobility and evasiveness, limiting their combat potential.
Earthbending¶
Earth is the element of substance. Earthbenders stay rooted to the ground, preferring to face opponents head-on, using a mix of defensive and offensive strategies to crush their foes.
Earthbending abilities focus on strengthening and defending oneself.
EarthBlast¶
EarthBlast is the main offensive ability for earth, where you throw earth at an entity to damage them
How to Use¶
While on your EarthBlast bind, first sneak while looking at an earthbendable block to select your source, then left click in the direction you want to throw the earth block.
Config¶
Permissions¶
| bending.ability.earthblast | Allows ability to be used, given by default |
Firebending¶
Fire is the element of power. Firebenders are very aggressive and powerful, choosing to overwhelm their opponents with an endless onslaught of offensive attacks.
Firebending abilities focus on boosting combat potential and destroying obstacles.
Waterbending¶
Water is the element of change. Waterbenders use their plethora of skills to redirect and manipulate opponents attacks against them.
Waterbending abilities focus on rapidly shifting between mobility, offense, and defense.
WaterManipulation¶
WaterManipulation is the main offensive ability for water, where the user creates a small torrent of water to damage and knockback entities
How to Use¶
While on your WaterManipulation bind, first sneak while looking at a waterbendable block to select your source, then left click in the direction you want the torrent of water to go toward.
Config¶
Permissions¶
| bending.ability.watermanipulation | Allows ability to be used, given by default |
Chiblocking¶
Chiblocking is the anti-bending fighting style. Chiblockers use critically placed kicks and punches to block chi paths in bender’s bodies disabling their bending.
Chiblocking abilities focus on close quarters combat and countering bending abilities.
QuickStrike¶
QuickStrike is a main offensive ability for chiblocking, the user precisely strikes an entity as to improve their chances of blocking the entity’s chi so they can’t bend.
How to Use¶
Hit an entity while on your QuickStrike bind
Config¶
Permissions¶
| bending.ability.quickstrike | Allows ability to be used, given by default |
FAQ¶
What Spigot version does the current plugin version support?¶
ProjectKorra Core v1.8.8 is compatible with Spigot 1.13.2 at the moment.
How can I report a bug?¶
ProjectKorra Core bugs can be reported here.
As of ProjectKorra Core v1.5.0, there is a debug feature built into the plugin. This will help us a ton when you submit a bug report if you include the debug.txt created when you use the /bending debug command in addition to a log of your console if it shows a visible error. Debug will help us by listing ProjectKorra plugins and dependencies so that we can isolate the source of the problem. This speeds up the bug fixing process A LOT.