{"id":12808,"date":"2023-06-06T16:31:48","date_gmt":"2023-06-06T16:31:48","guid":{"rendered":"https:\/\/test2.gginternal.net\/knowledgebase\/article\/how-to-set-up-and-use-spark\/"},"modified":"2023-06-06T16:31:48","modified_gmt":"2023-06-06T16:31:48","slug":"how-to-set-up-and-use-spark","status":"publish","type":"ht_kb","link":"https:\/\/ggservers.com\/knowledgebase\/article\/how-to-set-up-and-use-spark\/","title":{"rendered":"How to Set Up and Use Spark"},"content":{"rendered":"\n
\"\"\/<\/figure>\n\n\n\n

Mods and plugins are a great addition to your server that can make your game much more interactive and fun by adding new content and features.<\/p>\n\n\n\n

This guide will help you with setting up and using the Spark plugin or mod on your server.<\/p>\n\n\n\n

\n\n\n\n

\u2753 What Is Spark\u2753<\/h1>\n\n\n\n

Once you add plugins or mods, which are more demanding and sometimes add new content to your game, performance issues can pop up at any time. Spark is a plugin or mod that will help you identify the source of your lag or performance issues, so you can handle them.<\/p>\n\n\n\n

The Spark plugin and mod work for Minecraft versions 1.7 to 1.19.<\/p>\n\n\n\n

\n

You can read more about the Spark mod here<\/a> in the official documentation or here<\/a> on the official CurseForge page.
\nYou can read more about the Spark plugin here<\/a> in the official documentation or here<\/a> on the official Spigot page.<\/p>\n<\/blockquote>\n\n\n\n

\u26a0 NOTE<\/strong>\u26a0: You need to run as server type Forge or Fabric to be able to use the Spark mod version. If you are using the plugin version, Bukkit, Spigot, or Paper are required as server types.<\/p>\n\n\n\n

Our team may request a spark report from your server in certain tickets, so we can identify lag-related issues.<\/p>\n\n\n\n

\n\n\n\n

How to Install Spark <\/h1>\n\n\n\n

Spark can be set up as a plugin or a mod, depending on the server type you are using.<\/p>\n\n\n\n

\n\n\n\n

The Spark Mod<\/h2>\n\n\n\n

The first step is to make sure you are running Forge or Fabric.<\/p>\n\n\n\n

If not, here<\/a> is our guide for doing a clean installation of Forge or Fabric on your server. Beware that this process will delete all server files, so you will have to download anything important before.<\/p>\n\n\n\n

Here is our guide for installing mods on your server.\n<\/p>\n\n\n\n

\u26a0 NOTE<\/strong>\u26a0: If you are running Fabric, you will also have to install the FabricAPI mod as it is a dependency for Spark. You can find the FabricAPI mod here<\/a>.<\/p>\n\n\n\n

\n\n\n\n

Now, to set up the mod, you will have to:<\/p>\n\n\n\n

    \n
  1. Log in to your Multicraft panel here<\/a> and stop your server.<\/li>\n<\/ol>\n\n\n\n
    \"Stop<\/figure>\n\n\n\n
    \n\n\n\n
      \n
    1. Download the appropriate version of the mod here<\/a> according to the Forge\/Fabric version you are running.<\/li>\n<\/ol>\n\n\n\n
      \"Version\"\/<\/figure>\n\n\n\n
      \n\n\n\n
        \n
      1. Use FileZilla to upload the mod to your server’s mods<\/code> folder.<\/li>\n<\/ol>\n\n\n\n
        \"Upload\"\/<\/figure>\n\n\n\n

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

        \n\n\n\n
          \n
        1. Open your Multicraft panel and start your server.<\/li>\n<\/ol>\n\n\n\n
          \"Start<\/figure>\n\n\n\n
          \n\n\n\n

          The Spark Plugin<\/h2>\n\n\n\n

          The first step is to be sure you are running Bukkit, Spigot, or Paper.<\/p>\n\n\n\n

          If not, here<\/a> is our guide for changing your server type to Bukkit, Paper, or Spigot. It is recommended to do a backup before any server type changes. Here<\/a> is our guide for doing a backup.<\/p>\n\n\n\n

          Here<\/a> is our guide for installing plugins on your server.<\/p>\n\n\n\n

          \n\n\n\n

          Now, to set up the plugin, you will have to:<\/p>\n\n\n\n

            \n
          1. Log in to your Multicraft panel here<\/a> and stop your server.<\/li>\n<\/ol>\n\n\n\n
            \"Stop<\/figure>\n\n\n\n
            \n\n\n\n
              \n
            1. Download the appropriate version of the plugin here<\/a> according to the Bukkit, Spigot, or Paper version you are running.<\/li>\n<\/ol>\n\n\n\n
              \"Download\"\/<\/figure>\n\n\n\n
              \n\n\n\n
                \n
              1. Use FileZilla to upload the plugin to your server’s plugins<\/code> folder.<\/li>\n<\/ol>\n\n\n\n
                \"Upload\"\/<\/figure>\n\n\n\n

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

                \n\n\n\n
                  \n
                1. Open your Multicraft panel and start your server.<\/li>\n<\/ol>\n\n\n\n
                  \"Start<\/figure>\n\n\n\n
                  \n\n\n\n

                  How to Generate a Spark Report <\/h1>\n\n\n\n

                  To generate a Spark report, you will have to:<\/p>\n\n\n\n

                    \n
                  1. Log in to your Multicraft panel here<\/a> and start your server.<\/li>\n<\/ol>\n\n\n\n
                    \"Start<\/figure>\n\n\n\n
                    \n\n\n\n
                      \n
                    1. Use the \/spark profiler --only-ticks-over 150<\/code> command in-game or in the Multicraft console.<\/li>\n<\/ol>\n\n\n\n
                      \"\"\/<\/figure>\n\n\n\n

                      \u26a0 NOTE<\/strong>\u26a0: You need to use the command without the \/<\/code> at the beginning if you choose to use it via the Multicraft console (spark profiler --only-ticks-over 150<\/code>).<\/p>\n\n\n\n

                      \n\n\n\n
                        \n
                      1. Now that you have started the Spark profiler, you just need to play on your server for a minimum of 30 minutes, so the profiler can register your performance issues. The best results will be given when you experience lag on the server since Spark will be able to register that and provide you with a conclusive report.<\/li>\n<\/ol>\n\n\n\n
                        \"\"\/<\/figure>\n\n\n\n
                        \n\n\n\n
                          \n
                        1. Use the \/spark profiler --stop<\/code> command in-game or in the Multicraft console.<\/li>\n<\/ol>\n\n\n\n
                          \"\"\/<\/figure>\n\n\n\n

                          \u26a0 NOTE<\/strong>\u26a0: You need to use the command without the \/<\/code> at the beginning if you choose to use it via the Multicraft console ( spark profiler --stop<\/code> ).<\/p>\n\n\n\n

                          As you can see, the Spark profiler provided a link in the console logs. You will have to open the link with an internet browser to be able to see the generated report.<\/p>\n\n\n\n

                          \n\n\n\n

                          How to Read Your Spark Report <\/h1>\n\n\n\n
                          \"Spark<\/figure>\n\n\n\n

                          The profiler will list any process that took over 150 ms to execute, which is for sure causing lag on your server. You can click on them to open any subprocess. This way, you can find out which action, mob, or mod is responsible for the lag on your server.<\/p>\n\n\n\n

                          \u26a0 NOTE<\/strong>\u26a0: In Minecraft, when the code loop happens, we call that a tick, like the tick of a clock. There are 20 ticks per second, meaning every tick takes at most 50 milliseconds. 20 is known as TPS (ticks per second), and 50 is known as MSPT (milliseconds per tick). Because of that, if a tick takes longer than 50ms  (150 ms, for example), this will surely cause lag, as other actions have to wait for that tick to finish.<\/p>\n\n\n\n

                          \n\n\n\n

                          The spark report will also provide the class for any item listed, which can help you identify if the process was added by a specific plugin or mod.<\/p>\n\n\n\n

                          \"WorldEdit<\/figure>\n\n\n\n
                          \"Exotic<\/figure>\n\n\n\n
                          \n\n\n\n

                          You can also highlight processes in the report by right-clicking and then clicking on Toggle Bookmark<\/code>.<\/p>\n\n\n\n

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

                          In most cases, our team will request a Spark report from you to identify what is causing performance issues on your server.<\/p>\n\n\n\n

                          \n\n\n\n

                          If you find any issues setting up or using the Spark mod, contact us on live chat or via the ticket system<\/a>.\n<\/p>\n\n\n\n

                          \u2755Useful Links\u2755<\/h1>\n\n\n\n