Skip to content

Commit

Permalink
fix repo
Browse files Browse the repository at this point in the history
  • Loading branch information
JustAMatt committed Dec 25, 2023
1 parent 1bea88d commit b91d5f0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/plugins_and_modifications/plugins/geysermc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: geysermc
title: GeyserMC
slug: /plugins/geysermc
hide_title: true
hide_table_of_contents: true
sidebar_label: GeyserMC
description: A cool plugin called GeyserMC, which allows users to connect to java servers through the bedrock client.
Expand All @@ -14,8 +15,14 @@ keywords:
- Bloom.host
- Pterodactyl Panel
- Minecraft
image: https://bloom.host/assets/images/logo.png
---

<div class="text--center">
<img src="https://bloom.host/logo-white.svg" alt="logo" height="50%" width="50%"/>
<h1>GeyserMC</h1>
</div>

### What does the plugin do?

GeyserMC enables clients from Minecraft Bedrock Edition to join your Minecraft Java server.
Expand Down
21 changes: 18 additions & 3 deletions docs/running_a_server/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: spark
title: Taking a Spark Profile
slug: /spark
hide_title: true
hide_table_of_contents: true
sidebar_label: Taking a Spark Profile
description: How to run a Spark profile to identify causes of lag on your server.
Expand All @@ -14,8 +15,14 @@ keywords:
- Bloom.host
- Pterodactyl Panel
- Minecraft
image: https://bloom.host/assets/images/logo.png
---

<div class="text--center">
<img src="https://bloom.host/logo-white.svg" alt="logo" height="50%" width="50%"/>
<h1>Spark</h1>
</div>

### What does the plugin do?
Spark is a performance profiling plugin (with limited availability for Forge and Fabric) that can display server information, such as TPS, memory, tick durations, CPU usage, and disk usage. But more importantly it can create a performance profile that can be viewed on a fully feature web interface.
It does not require any configuration and is incredibly easy to install.
Expand All @@ -27,6 +34,11 @@ You can ignore this step if you are running Purpur 1.19.1 or above.
Download the latest build from [Spark](https://spark.lucko.me/download) and drop it into your plugins (or mod folder if you are running Forge/Fabric) folder. Turn on or restart the server, and you're done! If you need help installing plugins, check [How to install plugins](https://docs.bloom.host/installing-plugins).

## Using The Profiler

:::note
Some versions of spark use different command roots, /sparkb for BungeeCord, /sparkv for Velocity, and /sparkc for Fabric/Forge. If you are having trouble running the command try using the corresponding subfix.
:::

The most useful tool in terms of diagnostics is the profiler feature which can be run with `/spark profiler start`.

Usually you'll want to run the profile during a time of stress for your server, to get the most out of the report you should try to leave it running for 10 minutes or more. You can also add additional parameters to the report, for more information check the [Spark Documentation](https://spark.lucko.me/docs/Command-Usage)
Expand All @@ -35,17 +47,20 @@ Once you are ready to check the results of the profiler you should run `/spark p

When you open the link you'll find a useful web interface that displays all the data collected.

![img](/running_a_server/spark/1.png)
<div class="text--center">
<img src={require('../../static/imgs/running_a_server/spark/1.png').default} alt="img"/></div>

## Other Useful Commands

Running `/tps` will display an output that looks like this:

![img](/running_a_server/spark/2.png)
<div class="text--center">
<img src={require('../../static/imgs/running_a_server/spark/2.png').default} alt="img"/></div>

Running `/spark healthreport` will display an output that looks like this:

![img](/running_a_server/spark/3.png)
<div class="text--center">
<img src={require('../../static/imgs/running_a_server/spark/3.png').default} alt="img"/></div>

The values will depend on your server, newer versions of Spark will contain more useful information, as the utility is in active development.

Expand Down

0 comments on commit b91d5f0

Please sign in to comment.