Skip to content

Commit

Permalink
Update Kryptonite.
Browse files Browse the repository at this point in the history
  • Loading branch information
@lewmilburn
lewmilburn committed Sep 24, 2024
1 parent 985aa4e commit 70dd9bd
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 11 deletions.
9 changes: 9 additions & 0 deletions Writerside/topics/KR-Changelogs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@
<strong>You should always run the latest version of all software!</strong> That includes Kryptonite! Updating keeps your server free from bugs, exploits, and other potential issues. When you see the message - update!
</warning>

## 1.4.0
_2024-06-24_ - This version adds a GUI to KOS to allow administrators to select the profile that should be used in-game without having to access any configuration files. We've also added a new mob farm friendly profile.

| Added | Administrators can now select a KOS profile without having to access any configuration files if they run the command in-game, new FarmFriendly [profile](KR-Profiles.md) to prevent breaking mob farms. |
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Removed | Nothing was removed in this update. |
| Changed | Updated bstats to version 3.1.0 for better Folia compatibility. |
| Fixed | Nothing was fixed in this update, maybe nothing was broken? |

## 1.3.0
_2024-06-06_ - This version adds support for Folia, adds KOS profiles, and warns server administrator is it detects plugins that may cause additional lag.

Expand Down
4 changes: 3 additions & 1 deletion Writerside/topics/KR-Commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
| Command | Permission Required | Description | Usage | Console can run? |
|-------------------------|---------------------|--------------------------------|-------|------------------|
| /kryptonite /krypto /kr | None | About Kryptonite. | /kr | Yes |
| /kos | Operator | Kryptonite Optimisation System | /kos | Yes |
| /kos | Operator | Kryptonite Optimisation System | /kos | Yes* |
| /edb | Operator | Exploit Database | /edb | Yes |

*Running KOS from the console will use the kos.default-profile parameter in the [configuration](KR-Configuration.md).

## Permissions
Kryptonite commands can only be ran by players who are operators, or from the server console.

Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/KR-Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ For most users, leaving this on the default values will be fine.
| Value | Accepts | Default | Description |
|---------------------------------------------|---------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| update-check | Boolean | true | Should Kryptonite check the LewMC server for updates? This does not transfer any data from your server. |
| kos.profile | String | YouHaveTrouble | The name of the .kos file in the /profiles/ folder that Kryptonite will use. This will be verified before running. |
| kos.default-profile | String | YouHaveTrouble | The name of the .kos file in the /profiles/ folder that Kryptonite will use when being run from the console. |
| kos.override-pregenerated-world-protections | Boolean | false | You can enable this setting to override KOS's pre-generated world protections, this allows you to access treasure maps and dolphin features without pre-generating your world. This may cause additional lag if enabled. |
| kos.using-tcpshield | Boolean | false | Enable this if you're using TCPShield, this option prevents Kryptonite from applying patches that may cause instability or incompatibilities. Only affects Purpur Servers. |
19 changes: 12 additions & 7 deletions Writerside/topics/KR-Kryptonite-Optimisation-System.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,22 @@ It works by modifying configuration files to match values preconfigured in Krypt
Kryptonite does not optimise the server directly, it enables a number of configuration optimisations built-in to your server software. Because of this you can uninstall the software after running the command, as Kryptonite does not need to be on the server once the process has been completed. However, keeping Kryptonite on the server will give you update messages which may contain additional optimisations in the future.

## Using KOS
There's two ways to use KOS - you can either run our recommended patches, or change them. Whilst the underlying system is the same Advanced Mode has more customisation, but also takes a lot more time to configure. Both ways provide incredible optimisation and lag reduction benefits to your server. We recommend using the recommended patches first, and then customise them as you see fit if you'd like to.
### In-game
> This is the recommended way to use KOS.
### Running the Recommended Patches
It's super simple to use KOS with the recommended patches - just type /kos into your server's console or chat menu (you need to be operator if you're doing it in chat as a player), and follow the instructions. KOS will then automatically apply the best patches taken from the guide linked at the top of this page.
Run /kos in-game (you must be an operator), select the profile you'd like to use, and then tell KOS if your world is pre-generated.

### Customising KOS
Customising KOS brings a whole new layer of optimisation to KOS - and by that we mean you can optimise everything down to the very detail. KOS stores its patches in the 'profiles' folder that is created within the KOS folder. In there you'll find every value that is entered into your server's configuration files.
That's it! Once you're done, you can uninstall Kryptonite or keep it for update notifications.

Some of these values affect gameplay mechanics, or may need to be restricted/loosened as time goes on. Whilst this may seem like it adds an additional step to the process, having all of your configuration files in one place can help you to understand how they interact with each other. There's more information on what each of these values do over at the [Configuration page](KR-Configuration.md).
### From the console
First, check the profile you want to use is selected (see [configuration](KR-Configuration.md)).

Once you've edited these files, run /kos as you normally would.
Run /kos, then follow the instructions.

That's it! Once you're done, you can uninstall Kryptonite or keep it for update notifications.

### Custom Profiles
If you don't like the profiles we've provided, you can make your own! See [profiles](KR-Profiles.md) for more information.

### After KOS has finished.
Once you get the message saying it's done, restart your server and you're done! You can uninstall Kryptonite if you'd like to, or try the [Exploit Database](KR-Exploit-Database.md) next.
Expand Down
18 changes: 16 additions & 2 deletions Writerside/topics/KR-Profiles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@

Profiles are collections of settings or configuration options that can be used as templates for KOS.

There is currently only 1 provided profile: YouHaveTrouble.
## Provided Profiles
There is currently 2 provided profiles.

You can create a custom profile by copying one of the provided profiles, renaming it, and modifying it's values.
| Profile | Authors | Description |
|----------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| YouHaveTrouble | YouHaveTrouble (Values), LewMC (Kryptonite Port) | The YouHaveTrouble profile is an aggressive optimisation profile used to apply the [YouHaveTrouble Optimisation Guide](https://github.com/YouHaveTrouble/minecraft-optimization) to your server. This profile breaks a number of vanilla gameplay mechanics including mob farms and mob spawning, but is the most aggressive against lag and will yield the best results. |
| FarmFriendly | LewMC | This profile applies patches that won't break mob farms, but may yield less positive results. |

## Custom Profiles
You can create a custom profile by copying one of the provided profiles, renaming it, and modifying it's values.

If you're using KOS in-game, it should appear in the menu - if it does not, restart the server.

If you're using KOS from the console, you'll need to edit Kryptonite's [configuration](KR-Configuration.md) to run your custom profile.

### Sharing your Profile
If you'd like to share your profile with us to be added to KOS, we'd be happy to take it! You'll be given full credit via the in-game menu and profile list here, simply open an issue on [GitHub](https://github.com/lewmc/kryptonite) and send us the file.

0 comments on commit 70dd9bd

Please sign in to comment.