Features - cseelhoff/RimThreaded GitHub Wiki



Multi Threading

  • RimThreaded enables RimWorld to utilize multiple threads and thus greatly increases the speed of the game.

Job Caching

  • RimThreaded optimizes hauling and plant jobs by caching them.

Bypass Forced Slowdown

  • When a forced slowdown happens just hit your desired speed again.

TPS Meter

  • RimThreaded adds a TPS meter similar to TicksPerSecond. (Do not use TicksPerSecond with RimThreaded!)

Ultra Fast Speed.

  • Press "4" on your keyboard to use.
  • Similar to Smart Speed. (Do not use Smart Speed with RimThreaded!)

Total worker threads

alt text

  • This represents the number of threads that RimThreaded will attempt to utilize from your CPU.
  • It is recommended to keep this number at 1-2 times your CPU core count.
    • Keep in mind that as you go higher, Thread clashes and race conditions will become much more frequent.
    • Anything above 16 gives rapidly diminishing returns for performance.

Timeout

alt text

  • Default: 8000
  • This represents the time in milliseconds threads will try to process requests and calls.
  • It is recommended to keep this at the default unless for testing purposes to allow larger requests to be processed and not cause a thread restart.
    • An example of a large request is an endgame raid.
    • Do not set this value too high, As it may mask certain errors that might be important from being displayed in the debug log.

Speed Controls

alt text

  • Settings to configure desired TPS for each speed setting.
Speed Default Setting TPS Calculation Default TPS
1 > "Normal" 1 = Nₛₑₜ Nₛₑₜ * 60 = Nₜₚₛ Nₜₚₛ = 60
2 >> "Fast" 3 = Fₛₑₜ Fₛₑₜ * 60 = Fₜₚₛ Fₜₚₛ = 180
3 >>> "Superfast 12 = Sₛₑₜ Sₛₑₜ * 60 = Sₜₚₛ Sₜₚₛ = 720
4 >>>> "Ultrafast" 150 = Uₛₑₜ Uₛₑₜ * 60 = Uₜₚₛ Uₜₚₛ = 9000

Disable alert updates at 4x speed

alt text

  • Default: False
  • Self-explanatory, Do not show alerts when in 4x speed.

Disable thread/worker limit (debugging)

alt text

  • Default: False
  • Don't touch this unless you know what you're doing.

Disable slowdown on combat

alt text

  • Default: False
  • Stops the game from automatically switching to Normal speed when combat occurs.
  • A form of No Forced Slowdown is included in RimThreaded. (Do not use No Forced Slowdown with RimThreaded!)

Potential RimThreaded mod conflicts

alt text

  • This window will display method names that might conflict or cause issues with RimThreaded. With a medium-to-large modlist, This is probably going to have some things listed. If it's not too bad and you've read the wiki, it should be fine to ignore them.