https://github.com/wearblackallday/dimensionalthreading

An attempt to optimize the fabric server, by assigning each dimension their own thread.
https://github.com/wearblackallday/dimensionalthreading

fabric minecraft optimization

Last synced: 1 day ago
JSON representation

An attempt to optimize the fabric server, by assigning each dimension their own thread.

• Host: GitHub
• URL: https://github.com/wearblackallday/dimensionalthreading
• Owner: WearBlackAllDay
• License: mit
• Created: 2020-09-11T10:52:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-22T14:32:02.000Z (about 2 years ago)
• Last Synced: 2025-01-08T07:08:10.295Z (1 day ago)
• Topics: fabric, minecraft, optimization
• Language: Java
• Homepage:
• Size: 836 KB
• Stars: 257
• Watchers: 14
• Forks: 22
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DimensionalThreading 

This project is a free and open-source Minecraft mod which optimizes the processing of multiple Dimensions, by assigning them independent threads.

It works on both the **client and server**, and **does not** require the mod to be installed on both sides.

### Downloads

You can find downloads for DimThread on the [GitHub releases page](https://github.com/WearBlackAllDay/DimensionalThreading/releases). 

The Fabric API can be found on [Curseforge](https://www.curseforge.com/minecraft/mc-mods/fabric-api).

### Installing

Install the  [Fabric Loader](https://fabricmc.net/use).  Select Fabric for either the Minecraft launcher (client) or the dedicated server (server).

Once you have installed Fabric, move the`DimThread.jar`and the`Fabric-API.jar`into the`/mods`folder generated by Fabric.

---

### Configuration

##### DimThread comes with 2 native Gamerules:

- `/gamerule dimthread_active ` enables/disables the mod

- `/gamerule dimthread_thread_count `changes the amount of threads used

### FAQ

##### Does the mod change Vanilla behaviour?

DimThread aims to conserve vanilla-parity in all points. At the moment there are no known deviations in behaviour from Mojangs`server.jar`. If you notice any, feel free to [open an issue.](https://github.com/WearBlackAllDay/DimensionalThreading/issues)

##### Can my dimensions get de-synchronized?

As stated above this is **NOT** the case. DimThread will always synchronize the dimensions it threads with each other, setting the overall MSPT to the slowest individual dimension.

##### Are dimension counts above 3 supported?

Yes, but you will have to adjust the GameRule accordingly.

##### Will the server run faster if assign more than 3 threads to DimThread?

No, the mod can only assign one dimension to one thread.

##### Can i use DimThread if i have less threads on my CPU than dimensions?

The mod will not crash if you do not have enough threads available, but it will make the game **slower**. You should always have atleast`DimensionCount + 1`threads available.

##### How is the compatibility with other mods?

Compatibility with [JellySquids](https://github.com/jellysquid3) performance mods and [Carpet](https://github.com/gnembon/fabric-carpet) will be ensured and issues concerning them are accepted. If you plan on using a different mod compatibility cannot be guaranteed, since not every author writes their mod threadsafe.

##### What about older versions of Minecraft?

DimThread is written with 1.16 compatibility in mind, older versions are currently not considered. If you play on 1.12 you can use a similar project maintained by [2No2Name](https://github.com/2No2Name).

---

### License

DimThread is licensed under MIT, a free and open-source license. For more information, please read the [license file](https://github.com/WearBlackAllDay/DimensionalThreading/blob/master/LICENSE).