JoinEventsPro Documentation & Help

Sep 7, 2016
JoinEventsPro Documentation & Help
  • [​IMG]
    Welcome to the Wiki page for JoinEventsPro! Here, I will explain and Document my plugin from top to bottom. If you feel something should be added, let me know on the Discussion page or by PMing me.

    ---------------------------------------------------------------------------

    1.9 AND 1.10 SUPPORT
    Looking to have JoinEventsPro on your 1.9 or 1.10 server? Here's how to do it. It's simple, and quick.
    • All sorts of Join/Leave etc. Sounds, they must match your version.
    Like above, make sure your Join/Leave etc. Sounds match your version. If not, you will receive a common error like this. Check your sounds, and make sure they correspond with the correct version.



    ---------------------------------------------------------------------------

    ISSUE SELF CHECKER
    Have an issue with JoinEventsPro? Use this Issue Self Checker before posting a message on the Discussion page or PMing me.

    • Make sure you're running the latest version.
    Sometimes, updates have crucial bug fixes, so before coming to me for help, make sure you're running the latest version. It could save both you and me the hassle of trying to figure out what's wrong.
    • Remember, JoinEventsPro has permissions.
    I've had numerous people come to me saying that some part of the plugin isn't working. Remember, JoinEventsPro has permissions, and without them, normal players will not have any capabilities to my plugin. A list of all the permissions can be found on the Overview page.
    • Check all your other plugins to make sure there are no conflicting plugins.
    A way to check if there is a conflicting plugin is by removing all plugins except JoinEventsPro. After restarting your server with only JoinEventsPro installed, if your problem is fixed, then there is a conflicting plugin.
    • If you're testing to see if First Join Messages, Commands etc. work on your own username, don't expect them to work.
    Things like FirstJoinCommands, FirstJoinConsoleCommands etc. only execute you've never joined before. If you've joined with your username before, they won't work. I've had to emphasize this to many people.
    • If your problem persists, trying removing or renaming your JoinEventsPro directory.
    Surprisingly, this sometimes can be the issue. If all other methods above proved unsuccessful, then try removing or renaming your JoinEventsPro folder and restarting.

    ---------------------------------------------------------------------------

    THE CONFIG.YML EXPLAINED
    The config.yml is where all features of JoinEventsPro can be enabled, disabled, or changed. When you finish changing the config.yml, don't forget to type /jep reload to have your changes updated.

    • First Join Message
    The First Join Message is the message that appears when a player has joined your server for the first time, color codes are supported and the only variable that can be used is %player% which returns the player's name.
    • Join Message
    This is simply the message when a player returns to your server, color codes are supported and the only variable that can be used is %player% which returns the player's name.
    • Leave Message
    This is just the leave message when a player leaves your server, color codes are supported and the only variable that can be used is %player% which returns the player's name.
    • First Join MOTD
    This is the MOTD shown to a player when they have first joined. This MOTD can have unlimited lines, and every line MUST be surrounded by quotes, if not, this could create errors in the console. Color codes are supported and the only variable that can be used is %player% which returns the player's name.
    • Join MOTD
    This is almost the same as above, however, this is the MOTD when a player returns to your server. This MOTD can have unlimited lines, and every line MUST be surrounded by quotes, if not, this could create errors in the console. Color codes are supported and the only variable that can be used is %player% which returns the player's name.
    • First Join Commands
    These are the commands run by the player when they first join. There can be unlimited commands, but if you're for some reason using a color code in the command, make sure to surround that line in quotes.
    • Join Commands
    These are the commands run by the player when they return to your server. There can be unlimited commands, but if you're for some reason using a color code in the command, make sure to surround that line in quotes.
    • Console First Join Commands
    These are commands run by the console when a player first joins. There can be unlimited commands, but if you're for some reason using a color code in the command, make sure to surround that line in quotes. The only variable that can be used is %player% which returns the player's name.
    • Console Join Commands
    These commands are run by the console when a player returns to your server. There can be unlimited commands, but if you're for some reason using a color code in the command, make sure to surround that line in quotes. The only variable that can be used is %player% which returns the player's name.
    • Console Leave Commands
    These commands are run by the console when a player leaves the server. There can be unlimited commands, but if you're for some reason using a color code in the command, make sure to surround that line in quotes. The only variable that can be used is %player% which returns the player's name.
    • First Join Sound
    This is the sound that is played to the joiner on first join. The sound stated in the Sound section must be in all caps. The pitch is also configurable, but pitches can only be set from 0-2.
    • Join Sound
    This is the sound that is played to the joiner when returning to your server. The sound stated in the Sound section must be in all caps. The pitch is also configurable, but pitches can only be set from 0-2.
    • Global First Join Sound
    This is the sound that is played to the rest of the players online when another player first joins to your server. The sound stated in the Sound section must be in all caps. The pitch is also configurable, but pitches can only be set from 0-2.
    • Global Join Sound
    This is the sound that is played to the rest of the players online when another player returns to your server. The sound stated in the Sound section must be in all caps. The pitch is also configurable, but pitches can only be set from 0-2.
    • Global Leave Sound
    This is the sound that is played to the rest of the players online when another player leaves your server. The sound stated in the Sound section must be in all caps. The pitch is also configurable, but pitches can only be set from 0-2.
    • First Join Firework
    Pretty straight forward, if toggled to true, it will launch a firework when a player first joins.
    • Join Firework
    Same as above, but launches a firework when a player returns to your server.
    • First Join Kit
    This gives the player that has first joined your server certain items. There can be unlimited items given, and unlimited amounts. Items MUST follow this order: ITEM_NAME:AMOUNT. Here is an example, WOOD_PICKAXE:1, this will give a player one Wooden Pickaxe when they first join. Regardless, you must put a :1 after an item, even if you only want to give them one, if not, there will be an error in console. If you want to give a player more than one item, you can do like so: WOOD_PICKAXE:4. This will give the first joiner 4 Wooden Pickaxes.
    • Join Kit
    This gives the player that has returned your server certain items. There can be unlimited items given, and unlimited amounts. Items MUST follow this order: ITEM_NAME:AMOUNT. Here is an example, WOOD_PICKAXE:1, this will give a player one Wooden Pickaxe when they first join. Regardless, you must put a :1 after an item, even if you only want to give them one, if not, there will be an error in console. If you want to give a player more than one item, you can do like so: WOOD_PICKAXE:4. This will give the first joiner 4 Wooden Pickaxes.
    • Maintenance Mode
    Maintenance Mode can be enabled/disable either in the config.yml or with /jep maintenance. When enabled, this will not allow any players to join unless they are on the AllowedPlayers list, or have the jep.maintenancebypass permission. If a player is OPed, they will also be able to join during Maintenance Mode. Also, when in Maintenance, this will set the MOTD to whatever you would like in the config.yml. Color codes are supported.
    • Server MOTD
    This is the Server MOTD that appears on the server list. This is pretty straight forward, and supports color codes.
    • Max Players
    Sets the Max Players to the value you specify. In the config, it has a Amount section where you can change the amount, reload, and it will update, OR you can use /jep setmaxplayers amount to set it on the fly!
    • Unlimited Players
    This allows you to have unlimited players on your server. So if your host limits you to only 20 players, you can have unlimited players. Basically, it adds 1 to the player count. So if there are 241 people on your server, it will show like so: 241/242.
    • Whitelist
    Server whitelist can be toggled with /jep whitelist. You can have a certain message when a player tries to join while your server is whitelisted, color codes are supported. There can also be an unlimited amount of players that can be added to the AllowedPlayers list. To bypass whitelist, you can also use the jep.whitelistbypass permission.
    • Server Full
    When your server is full, you can set a custom message to appear, and have a bypass list of players. You can also use jep.fullbypass. This is not recommended to be enabled with UnlimitedPlayers because it will practically do nothing.
    • First Join Location
    This is where the First Join Location data will be stored, you can toggle it off if you would not like to have players spawn in a certain location upon first join. To set the location, you must type /jep setfjoinlocation where you would like the players to spawn upon first join.
    • Join Location
    This is where the Join Location data will be stored, you can toggle it off if you would not like to have players spawn in a certain location upon returning to your server. To set the location, you must type /jep setjoinlocation where you would like the players to spawn upon returning to your server.

    ---------------------------------------------------------------------------

    FAQ - FREQUENTLY ASKED QUESTIONS
    These are some Frequently Asked Questions regarding JoinEventsPro.

    • Why is nothing working when a player joins?
    If your players do not have any JoinEventsPro permissions, nothing will happen. Make sure your players have all the permissions they need before coming to me for help.
    • It says "First Join Location/Join Location does not exist" when I join my server. How do I fix this?
    It says this because your First Join Location or Join Location is toggled to true, but it doesn't exist. To set the First Join Location, type /jep setfjoinlocation. To set the Join Location, type /jep setjoinlocation.
    • The author isn't responding to my messages! What do I do?
    Please do not come to this conclusion within a short period of time. I am sometimes busy and do not have time to respond to messages. But I do try my best to respond to messages as soon as I can :).
    • Does JoinEventsPro support 1.9 or 1.10?
    Yes! Scroll to the very top and view "1.9 and 1.10 support" to learn how to make your server run JoinEventsPro on 1.9 or 1.10.
    • What version do you think would work best for JoinEventsPro?
    Definitely 1.8, it has been tested the most on 1.8 and you're guaranteed to have no issues when running JoinEventsPro on 1.8.
    • I want a feature to be added to JoinEventsPro, how do I do this?
    If you want a feature added, let me know via PM. I'm always happy to add new things to JoinEventsPro, especially if others want it.
    • How can I show my support for JoinEventsPro?
    The best way to appreciate my work is to leave a nice rating or donate to me here :).
  • Loading...
  • Loading...