Skip to content

vopaga/rocketman-lite

Repository files navigation

RocketMan Lite - Mod Caching System

A standalone, lightweight mod caching system extracted from the original RocketMan performance mod for RimWorld.

📚 Documentation

For Building:

For Testing:

🚀 Quick Setup for Development

  1. Install .NET SDK (~150-200 MB): https://dotnet.microsoft.com/download/dotnet/8.0
  2. Build: .\build.ps1
  3. Result: 1.6\Assemblies\RocketManLite.dll

See WHAT_TO_INSTALL.md for details.

🧪 Quick Testing

After building, test the mod:

# 1. Analyze logs automatically
.\analyze-logs.ps1

# 2. Or follow quick testing guide
# See QUICK_TEST.md for 3-step testing instructions

Expected result: Second game launch should be 10-30% faster!


What is this?

RocketMan Lite dramatically reduces RimWorld startup time by caching loaded mod definitions (XML files). Instead of parsing all mod XMLs on every game launch, it creates a unified cache file and reuses it on subsequent launches.

Features

  • Fast Startup: Significantly reduces game loading time with large mod lists
  • 🔄 Automatic Cache Management: Automatically detects when mods change
  • 🪶 Minimal Dependencies: Only requires Harmony
  • 🔍 Smart Validation: Uses file hashing to detect changes accurately
  • 🛠️ Debug Tools: Built-in logging and cache management

How It Works

First Launch

  1. Reads all mod XML files normally
  2. Computes MD5 hashes for each file
  3. Creates a unified cached XML file
  4. Saves mod list and file hashes

Subsequent Launches

  1. Checks if mod list changed
  2. Validates file hashes
  3. If nothing changed → loads from cache (FAST!)
  4. If something changed → rebuilds cache

Installation

  1. Subscribe on Steam Workshop (link TBD) or download manually
  2. Enable "RocketMan Lite" in your mod list
  3. Place it near the end of your mod order (after content mods)
  4. Restart the game

Configuration

Access settings via: Options → Mod Settings → RocketMan Lite

  • Enable Debug Logging: Shows detailed caching information
  • Clear Cache: Forces cache rebuild on next launch

Cache Location

Caches are stored in:

C:\Users\<YourName>\AppData\LocalLow\Ludeon Studios\RimWorld by Ludeon Studios\RocketManLite\Cache\

Files created:

  • Unified.xml - Consolidated mod definitions
  • ModList.xml - List of active mods
  • AssetsHash.xml - File hash registry
  • AssetsHashInt.xml - Fast hash comparison data

Performance

Typical results with 200+ mods:

  • Without cache: ~3-5 minutes loading time
  • With cache: ~30-60 seconds loading time

Results vary based on mod count, file sizes, and system specs.

Compatibility

  • ✅ Works with all mods (no known conflicts)
  • ✅ RimWorld 1.6 (Anomaly)
  • Not compatible with RimThreaded
  • ⚠️ Multiplayer not tested

Troubleshooting

Game won't start after enabling

  • Disable RocketMan Lite
  • Delete cache folder
  • Re-enable and restart

Mods not loading correctly

  • Use "Clear Cache" button in mod settings
  • Restart game

Still slow loading

  • Check if cache is being created (enable debug logging)
  • Verify mod order (RocketMan Lite should be near the end)

Credits

License

MIT License - See LICENSE file for details

Based on RocketMan by Krkr (MIT-licensed original project). This fork is maintained by vopaga and is not officially affiliated with the original author.

Contributing

Issues and pull requests welcome at: [Repository URL]

Changelog

Version 1.0.0

  • Initial release
  • Extracted caching system from RocketMan
  • Standalone implementation with minimal dependencies
  • Added configuration UI

About

Rimworld performance mod

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors