Particles - How To Use

Oct 7, 2018
Particles - How To Use
  • [​IMG]

    QUICK START
    If used properly, Particles can be more than whats advertised, and become an extremely powerful tool. To get started, running the command "/p" will open the most premium inventory permissible to the player. Since there is no command interface for Particles, the GUI is how they will interact with the plugin. With 13 formats, all particles, and the ability to color some particles, there are endless possibilities for creativity. A side note, the particles 'block_crack', 'block_dust', and 'falling_dust' all base their particles off of the block you're standing on, as 'item_crack' bases it's particle off of the item in your off-hand.

    COMMANDS

    • /<particles / part / pe / p> - Base command, opens GUI if available.
    • /p <off/dis/disable> - Turns off any active particles.
    • /p check - Checks for newer Particles version.
    • /p download - Downloads latest version of Particles.
    • /p update - Installs latest particles, then reloads the server.
    • /p reload - Reloads the plugin.
    CONFIGURATION
    Configuring particles is a task in and of itself, but can produce astonishing results. lets start with the main config.

    [​IMG]

    config.yml
    Code (YAML):
    SQL:
        Use SQL
    : false
        Ip
    : localhost
        Port
    : '3306'
        Database
    : particles
        Username
    : root
        Password
    : '1234'
    Inventories (Ranked in order of Premium[Top] -> Basic[Bottom])
    :
    - New Inventory
    SQL
    Starting off with SQL settings, please enter only the IP, and no address settings, as the plugin does this on it's own. Fill in the rest of your SQL server information, and a plugin reload should do the trick! Particles will now support server reloads, players logging on and off, and the additional player transfer between servers on a network.

    RANKED INVENTORIES
    This is the list of inventories sent to the player to open. The first entry in the list will be considered first for the player to open, as will the last entry be considered last. If the player has no permission to open any inventories, they will be sent the no permission message.


    [​IMG]

    config_advanced.yml
    Code (YAML):

    Miscellaneous
    :
        Count Looking As Movement
    : false
    Messages
    :
        Unknown Command
    : '&cUnknown command.'
        No Permission
    : '&cYou do not have permission for that.'
        Particles Disabled Message
    : '&7Particles &cDisabled&7.'
        Reloading
    : '&6Particles reloading...'
        Reload Success
    : '&aPlugin reloaded successfully!'
        Reload Fail
    : '&cPlugin reload failed! &4(Particles Disabled)'
        Up To Date
    : '&aYour current version of particles is up to date!'
        Out Of Date
    : '&cYou are currently out of date!'
        Download Success
    : '&aPlugin update successfully downloaded!'
        Download Failed
    : '&cUnable to download the latest version.'
        Update On Restart
    : '&6Update will apply when server is restarted.'
    COUNT LOOKING AS MOVEMENT
    This options allows for players looking around, to count as a player movement. This will affect the standing and moving format options by determining which format to play.

    MESSAGES
    All messages used in the plugin.

    [​IMG]

    New Inventory.yml
    Code (YAML):
    Title: '&5New Inventory'
    Size
    : 9
    Permission
    : particles.inventory.new
    Filler
    :
        Name
    : '&6Default Item'
        Material
    : STONE
        Amount
    : 1
        Damage
    : 0
        Lore
    :
       - ''
    Slots
    :
        '0'
    :
            Name
    : '&6Default Item'
            Material
    : STONE
            Amount
    : 1
            Damage
    : 0
            Lore
    :
           - ''
            Actions
    :
           - Default Action
    MAIN INVENTORY OPTIONS
    The title must be surrounded by single quotes. The size must be in increments of 9. And the permission (for the moment), is for the ranked inventories in the main config. The filler option is just to fill in the empty spaces of the inventory. Every slot must be numbered, and MUST have the single quote ('). The slots option is where all the action happens. Each action in the actions list will be the name of the action in the actions config. Each one will be performed in the order listed. /^>

    [​IMG]

    actions.yml
    Code (YAML):
    Actions:
        Default Action
    :
            '0'
    :
                Action Type
    : send message
                Message
    : This option has not been set-up yet.
     
    ACTIONS
    This is the most critical part of the whole plugin, but also the most complicated... pay attention. For reference, we will refer to each named group the action package, and each number of the package the action. Each package is case sensitive. Each action must be numbered 0-X. (Where X is the last number package) These actions DO NOT have to be in order, as they will be executed in number order. However, they MUST be within the proper range. So if you have 3 actions, your action numbers must be '0', '1', and '2'. These numbers MUST also have single quotes around them. One more note, is that if an original value has or doesn't have a decimal, it must ALWAYS stay that way. Other than that, along comes the easy part.This system is mostly automated. All you need to do, is enter the "Action Type" under the action, and try running it once. (Via gui selection) The values for that action type will automatically generate in the config file. If you use the "clear and toggle particles" action, it MUST be numbered first before other actions. The action types are not case sensitive, but they require all the words with proper spacing. All action types can be located below.
    • 'add particle' - Adds the particle package.
    • 'clear particles' - Clears any active particles.
    • 'clear and toggle particles' - Toggles particles in package, clears other particles.
    • 'close inventory' - Closes any open inventories.
    • 'run command' - Runs command from console or player.
    • 'send message' - Sends a message to the player.
    • 'none' - Perform no action.
    • 'open inventory' - Opens the specified custom inventory.
    • 'remove particle' - Removes the particle package.
    • 'play sound' - Plays the specified sound.
    • 'toggle particles' - Toggles the particle package.

    [​IMG]
  • Loading...
  • Loading...