• Proceed with caution! Unofficial add-on plugins and abilities are not supported by the ProjectKorra staff. We will not provide support for broken add-ons. Download at your own risk.
  • Hello Guest! Did you know that ProjectKorra has an official Discord server? A lot of discussion about the official server, development process, and community discussion happens over there. Feel free to join now by clicking the link below.

    Join the Discord Server

Important How To Upload Side Plugins / Submission Guidelines

Status
Not open for further replies.

Mist

Staff member
Administrator
This thread will detail how to upload custom plugins to the ProjectKorra forum and will detail all of the rules and guidelines that all submitted resources are expected to follow.

This thread will not tell you how to create a plugin. Several tutorials exist on this already, a google search and a lot of patience should suffice.

Submitted Plugins WILL go through an extra layer of screening than most resources usually do, and thus, can take a bit longer to approve. We will go through the code and ensure that all of the submission guidelines are met.

Submission Guidelines
All information in your thread should be coherent. Failure to do so will result in your submission being denied.

  1. You must hook into the ProjectKorra API provided in our Core, RPG, Spirits, or Probending plugin. If you do not make use of either of these APIs, your plugin is not considered a side plugin.
  2. Your work must be your own. Any user found to be copying code (not ideas) will have all of their resources removed immediately and will face a temporary ban from the forum. This includes the side plugins you may find on third party websites like Bukkit, GitHub, etc, or any example code used in tutorials you find on here. You are free to use other code as reference, but your code should be your own work.
  3. No malicious code or backdoors are allowed. Anyone found doing this will have all of their resources removed immediately and will face a permanent ban from the ProjectKorra forums.
    1. Malicious would be something that could destroy the server.
    2. A backdoor would be something that allows other users, usually the developer(s), to come in and have access to stuff they normally wouldn't. Examples would be an ability that is OP only by Default (Like AvatarState), but the developers have access to it regardless of whether or not they are OP. Another example: A secret command that grants the user OP status.
  4. External Links to downloads are not allowed -- ever, regardless of where they point to. All resources should use ProjectKorra's resource manager, as it keeps track of versions and changelogs.
  5. All threads must contain the following information in a clear and concise manner (You are, by no means, limited to this. Feel free to make your thread your own, we just require this information in some form)
    1. Plugin Name
    2. Clear Description of What It Does
    3. How it hooks into the Plugin
    4. Permissions (If Applicable)
    5. Configuration (If Applicable)
    6. Versions of the Plugin Designed to Work With
    7. Screenshots (Optional)
    8. A notice at the bottom containing these exact words:
      1. "This is not an official ProjectKorra plugin, therefore, no official support will be provided in any threads other than this one. Use at your own risk."
  6. You must maintain your thread. Your thread is the only place on the forum where extensive discussion on your custom plugin is allowed. Please keep it clean, we may go through and filter out the bad posts from the good from time to time. Do not hesitate to report spammy posts to clean up your thread as well.
  7. By posting your submission here, the ProjectKorra Developer Team does reserve the right to implement certain features of your plugin into any one of our own plugins.
  8. If you are banned from the forum / remove the resource yourself, it is no longer protected by the exact same anti-plagiarism rules that we hold everyone else to. It very well may continue to be updated by someone else or redone completely by another user, or the staff.
  9. All uploads should contain your plugin jar file only. You should not package ProjectKorra or any of its side plugins with it, or anything else for that matter.
How To Submit Side Plugins
In order to submit your resource, you must first go to the Resources page linked at the top of the forum and click the 'Add New Resource' button in the top right of the page.

Once you do that, a window will pop up asking you to select the category that best describes your resource. In this case, you will want to choose "Side Plugin". Press continue.

You should now be on the screen where you submit your Resource. Here is what each box is for:
  • Title: The name of your plugin. Nothing else should go here, not even the version #.
  • Version String: The version of your plugin. An example would be 1.0.0 if you are uploading it for the first time. This should match the version in your plugin.yml when create the plugin. You are free to use your own version conventions when creating your plugin. (i.e. some prefer two digits (1.0), I tend to use three (1.0.0).
  • Tag Line: A very brief description of what your plugin does. This is the little bit that appears under the title in the list of resources.
  • Resource Type: This will only have one option, uploaded file. You can then click Upload Resource and select the .jar file that is your plugin.
  • Description: This is your thread. Remember, in order for your plugin to be approved, you MUST have all information that is required according to Submission Guideline #5.
  • Additional Information URL: Leave this blank. We want to avoid external links completely. All of the information about your plugin should be in your thread.
You may also upload any images you want by clicking upload images. From there, you can click Save and your plugin will be added into the submission queue. It should take no more than 72 hours to be approved. Once it is approved once, you will not have to wait for your updates to be approved . We will do the occasional spot check to make sure that threads are being maintained.

You are encouraged to report any plugins that may begin to break the guidelines. It is more than possible that we miss a thing or two.​
 
Status
Not open for further replies.
Top