{"id":13051,"date":"2019-07-20T09:24:48","date_gmt":"2019-07-20T09:24:48","guid":{"rendered":"https:\/\/test2.gginternal.net\/knowledgebase\/article\/how-to-set-up-and-use-essentialsx\/"},"modified":"2019-07-20T09:24:48","modified_gmt":"2019-07-20T09:24:48","slug":"how-to-set-up-and-use-essentialsx","status":"publish","type":"ht_kb","link":"https:\/\/ggservers.com\/knowledgebase\/article\/how-to-set-up-and-use-essentialsx\/","title":{"rendered":"How to Set Up and Use EssentialsX"},"content":{"rendered":"\n
\"\"\/<\/figure>\n\n\n\n

The famous Essentials plugin was discontinued in 2014, for this reason, some developers started to continue the great plugin, leaving the plugin updated and more functional. EssentialsX is an example of this continuation.<\/p>\n\n\n\n

This simple lightweight plugin introduces a lot of features that will help you with your server. For this reason, GGServers highly recommend users use this plugin.<\/p>\n\n\n\n

This article will try to help you with the installation and basic features of the plugin.<\/p>\n\n\n\n

We HIGHLY recommend you, reader, to use Notepad + +<\/a> to edit any files from your FTP. By using Notepad ++ you can keep the format and spacing landing to not break the file when editing.<\/p>\n\n\n\n

\n\n\n\n

\u26a0 Important Notes \u26a0<\/h1>\n\n\n\n

Important note: EssentialsX can run only on CraftBukkit, Spigot, or Paper as it is a plugin.<\/p>\n\n\n\n

EssentialsX has some extra modules that you have to install separately if you want those functions: EssentialsX Chat, EssentialsX Spawn, EssentialsX AntiBuild, EssentialsX Discord, EssentialsX Geo, EssentialsX Protect, and EssentialsX XMPP. You can find them here<\/a>.<\/p>\n\n\n\n

We recommend you set up EssentialsX on any server as it is a default plugin that provides a lot of useful functions.<\/p>\n\n\n\n

\n\n\n\n
\"\"\/<\/figure>\n\n\n\n

\ufe0f Installing the Plugin \ufe0f<\/h1>\n\n\n\n

You can set up the EssentialsX plugin manually or using our Multicraft auto-installer.<\/p>\n\n\n\n

\n\n\n\n

Manual Installation<\/h2>\n\n\n\n

To install the plugin manually you need to:<\/p>\n\n\n\n

    \n
  1. Download the latest EssentialsX build from here<\/a> and also any other addition you want (EssentialsChat, EssentialsXMMP, etc).<\/li>\n<\/ol>\n\n\n\n
    \"\"\/<\/figure>\n\n\n\n
    \n\n\n\n
      \n
    1. Use FileZilla to upload the plugin (and any addition you want) to your server plugins<\/code> folder.<\/li>\n<\/ol>\n\n\n\n
      \"\"\/<\/figure>\n\n\n\n

      Here<\/a> is our guide for using FileZilla.<\/p>\n\n\n\n

      \n\n\n\n
        \n
      1. Start your server.<\/li>\n<\/ol>\n\n\n\n

        You just set up the EssentialsX plugin manually.<\/p>\n\n\n\n

        \n\n\n\n

        Automatic Installation via Multicraft<\/h2>\n\n\n\n
          \n
        1. Log in to your Multicraft here and stop your server.<\/li>\n<\/ol>\n\n\n\n
          \n\n\n\n
            \n
          1. Select Installers<\/code> and then Plugin Installer<\/code>.<\/li>\n<\/ol>\n\n\n\n
            \"\"\/<\/figure>\n\n\n\n
            \n\n\n\n
              \n
            1. Type essentialsx<\/code> on the search bar and click on EssnetialsX<\/code>.<\/li>\n<\/ol>\n\n\n\n
              \"\"\/<\/figure>\n\n\n\n
              \n\n\n\n
                \n
              1. Click on Install<\/code> and then start your server.<\/li>\n<\/ol>\n\n\n\n
                \"\"\/<\/figure>\n\n\n\n

                We highly recommend you to also install the Vault<\/a> plugin and a permissions plugins such as LuckPerms<\/code> to be able to fully use EssentialsX. Here<\/a> is our guide for setting up and using LuckPerms.<\/p>\n\n\n\n

                \n\n\n\n

                Summary of Functions <\/h1>\n\n\n\n

                \u2688 Economy Functions
                \n\u2688 Warps
                \n\u2688 Kits
                \n\u2688 Enchantments
                \n\u2688 Spawners
                \n\u2688 Protection
                \n\u2688 Warp\/Kits\/Enchant signs and more!
                \n\u2688 Buy & Sell signs
                \n\u2688 Homes
                \n\u2688 Spawn
                \n\u2688 Chat formatting
                \n\u2688 MOTD configurations
                \n\u2688 Much more!<\/p>\n\n\n\n

                You can find every EssentialsX command and function here<\/a>.<\/p>\n\n\n\n

                \n\n\n\n

                Permissions <\/h1>\n\n\n\n

                Each command that EssentialsX is providing has a permission node assigned. Here you can find all permissions nodes for the EssentialsX plugin.<\/p>\n\n\n\n

                We have a guide here<\/a> explaining what a permission node is.<\/p>\n\n\n\n

                \n\n\n\n

                \u2697\ufe0f EssentialsChat Color Codes \u2697\ufe0f<\/h1>\n\n\n\n

                You can also use color codes to make your chat better.<\/p>\n\n\n\n

                \"\"\/<\/figure>\n\n\n\n

                Please note that you need to also add the EssentialsX Chat addition to use this function.<\/p>\n\n\n\n

                \n\n\n\n

                Sign Control <\/h1>\n\n\n\n

                To enable signs, remove the #<\/code> symbol from each line that you’d like to active the sign. You can find it inside EssentialsX’s config.yml<\/code> file.<\/p>\n\n\n\n

                You can find all instructions for using signs here<\/a> too on the official documentation for EssentilsX.<\/p>\n\n\n\n

                To disable all signs, comment\/ remove each sign. Inside EssentialsX config file you’ll see the following lines:<\/p>\n\n\n\n

                enabledSigns:\n  #- color\n  #- balance\n  #- buy\n  #- sell\n  #- trade\n  #- free\n  #- disposal\n  #- warp\n  #- kit\n  #- mail\n  #- enchant\n  #- gamemode\n  #- heal\n  #- info\n  #- spawnmob\n  #- repair\n  #- time\n  #- weather\n<\/code><\/pre>\n\n\n\n
                You just need to remove #<\/code> from EssentialsX’s signs you’d like to be activated.<\/p>\n\n\n\n
                \n\n\n\n
                Example:<\/p>\n\n\n\n
                enabledSigns:\n  #- color\n  #- balance\n  - buy\n  - sell\n  #- trade\n<\/code><\/pre>\n\n\n\n
                In the example above, only buy<\/strong> and sell<\/strong> signs will be enabled.<\/p>\n\n\n\n
                Please note that you must restart your server or reload the plugin with \/essentials reload<\/code> to get changes consolidated.<\/p>\n\n\n\n
                In the example above we activated both signs, Buy and Sell. Inside the Sign, the values that we must type to do it are:<\/p>\n\n\n\n
                \"\"\/<\/figure>\n\n\n\n
                [Buy] or [Sell]\n<amount>\n<itemID>\n<Cost>\n<\/code><\/pre>\n\n\n\n
                This applies for buy and sell<\/strong> signs. To see for all signs PLEASE<\/strong> check on here -> EssentialsX Sign Formatting<\/a>.<\/p>\n\n\n\n
                \n\n\n\n
                \u2699\ufe0f Setting Up Kits \u2699\ufe0f<\/h1>\n\n\n\n
                Creating Kits is very easy with EssentialsX. You can simply create a kit by using your stuff in your inventory.<\/p>\n\n\n\n
                \n\n\n\n
                Imagine that you’re an Admin of some server that you’d like to create a new kit for your players called AwesomeKit<\/code>.<\/p>\n\n\n\n
                There are two ways to set it up:<\/p>\n\n\n\n
                  \n

                1. Setting it up in-game, which is the simplest way.<\/p>
                  <\/li>\n\n\n\n

                2. Setting it up by editing the EssentialsX’s config file inside your server files.<\/p>
                  <\/li>\n<\/ol>\n\n\n\n
                  \n\n\n\n
                    Setting Up Kits In-Game<\/h2>\n\n\n\n
                  Firstly, you will need to clear your inventory.<\/p>\n\n\n\n
                  Then use your inventory as a chest<\/code> to store which elements you’d like your AwesomeKit<\/code> to have. Imagine that you’ve chosen the following items:<\/p>\n\n\n\n
                  \"\"\/<\/figure>\n\n\n\n
                  Once everything that you’d like in your AwesomeKit<\/code> is in your inventory, you can use the command:<\/p>\n\n\n\n
                  \/createkit <name> <cooldown><\/code>.<\/p>\n\n\n\n
                  By doing this, EssentialsX will read your inventory and will create your wished kit based on which items you left in your inventory. To delete some Kit use the command:<\/p>\n\n\n\n
                  \/delkit <name><\/code>.<\/p>\n\n\n\n
                  \n\n\n\n
                    Kits for New Players<\/h2>\n\n\n\n
                  Newbies:<\/strong><\/p>\n\n\n\n
                  If you are using the EssentialsX Spawn, you can a spawn point or a welcome message. Then, you can also give new players a kit. This can be used to give a kit (or kits) to get the player started, or could be used to give special items such as a book of server rules.<\/p>\n\n\n\n
                  Inside EssentialsX config you just need to set wished kit in the newbies<\/code> option under kits<\/code> section.<\/p>\n\n\n\n
                  Example:<\/strong><\/p>\n\n\n\n
                  newbies:\n  kit: tools\n<\/code><\/pre>\n\n\n\n
                  \n\n\n\n
                    Important Notes Regarding Kits<\/h2>\n\n\n\n
                  The following notes are talking about Permissions Nodes, so you will have to also set up a permission plugin like LuckPerms before.<\/p>\n\n\n\n
                  \u2688 For players to be able to use kit commands, they need to have the permission essentials.kit<\/code> in their groups. This will allow users to access \/kit<\/code> command.<\/p>\n\n\n\n
                  \u2688 To allow players to get some kit, you must specify this, using permissions nodes, which Kits the players\/ groups will have access by using\/ adding the permission essentials.kits.<kitname><\/code>.  If you notice the example above, we created a kit called AwesomeKit<\/code>, so if we would like to make someone able to get that kit, you’ll just need to add the permission node essentials.kits.AwesomeKit<\/code> to the wished groups\/players using your current permission plugin.<\/p>\n\n\n\n
                  \u2688 The permission essentials.kit<\/code> is required for \/kit<\/code> command but it is not required for kit signs.<\/p>\n\n\n\n
                  \n\n\n\n
                    Setting Up Multiple Homes  <\/h1>\n\n\n\n
                  You can use EssentialsX and a Permission plugin like LuckPerms to give players one or more homes.<\/p>\n\n\n\n
                  We have a guide here<\/a> explaining how to set up multiple homes via EssentialsX, please read it for instructions.<\/p>\n\n\n\n
                  \n\n\n\n
                  If you find any issues setting up and using EssentialsX please contact us on live chat or via the ticket system<\/a>.<\/p>\n\n\n\n
                  \n\n\n\n
                  \u2755 Useful Links \u2755<\/h1>\n\n\n\n