Skip to content

Commit

Permalink
docs: extend README
Browse files Browse the repository at this point in the history
  • Loading branch information
getchoo committed Jul 24, 2024
1 parent 243b8bb commit 6e24de3
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# ThreadTweak

Improve and tweak Minecraft CPU scheduling (again!)
> Improve and tweak Minecraft CPU scheduling (again!)
[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/github_vector.svg)](https://github.com/skywardmc/threadtweak)
[![fabric](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg)](https://fabricmc.net)
[![quilt](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg)](https://quiltmc.org)

ThreadTweak lets you improve and tweak Minecraft CPU scheduling. It is a maintained version of the [original Smooth Boot mod](https://github.com/UltimateBoomer/mc-smoothboot), allowing you to still change CPU thread priorities in-game.

## Features

Expand All @@ -10,6 +16,30 @@ Improve and tweak Minecraft CPU scheduling (again!)

For more information, please read the [Smooth Boot Wiki](https://github.com/UltimateBoomer/mc-smoothboot/wiki).

## FAQ

### Why was this made if it's no longer needed?

While the main function of Smooth Boot was fixed in 1.19.4, the mod still allows you to adjust thread priorities, which can still be quite beneficial on some systems as shown in [UltimateBoomer/mc-smoothboot #54](https://github.com/UltimateBoomer/mc-smoothboot/issues/54).

### Is this faster than the original mod?

Not in any way - this is only a maintained version of the final version of Smooth Boot. There may or may not be extra features or improvements added as requested or while I have the time.

## Special Thanks

[UltimateBoomer](https://github.com/UltimateBoomer) was the original creator of [Smooth Boot](https://github.com/UltimateBoomer/mc-smoothboot), which this project is based on. Much credit should go to them for originally creating and maintaining it for so long :)

<details>
<summary>Email with permission from the original author</summary>

Hello Devin,

I certainly have no problems if you want to maintain a fork of Smooth Boot for future versions of Minecraft. I understand that Smooth Boot can still be useful in version 1.20 and later, though personally I'm not interested in maintaining the mod right now. I also suggest a different name to be used, though you don't have to if you don't want to. Smooth Boot's original purpose of making Minecraft launch faster is no longer necessary, so a different name would convey the purpose of the mod more accurately.

Thanks,

UltimateBoomer

</details>

0 comments on commit 6e24de3

Please sign in to comment.