Requirements
Fabric Loader
Minimum version: 0.18.4 The mod requires Fabric Loader version 0.18.4 or higher. This version is specified in the mod’s dependencies.Fabric API
Required version: 0.141.1+1.21.11 Fabric API is required for Soul Link Speedrun to function. The mod uses several Fabric API modules including:- Lifecycle Events
- Networking API
- Command API
- Entity Events
While the mod is developed against Fabric API version
0.141.1+1.21.11, it should work with other Fabric API versions compatible with Minecraft 1.21.11.Bundled Dependencies
Fantasy:0.7.0+1.21.11
The Fantasy library by NucleoidMC is bundled within the mod JAR. This library provides runtime world generation capabilities.
You do NOT need to install Fantasy separately - it’s included in the Soul Link Speedrun JAR file.
Known Compatibility Issues
Soul Link Speedrun modifies core game mechanics, which may conflict with other mods that touch similar systems.Health & Hunger Modifiers
Potential conflicts:- Mods that change max health
- Mods that add custom hunger/saturation mechanics
- Mods that override damage calculations
- Mods that modify food consumption
Portal & Dimension Mods
Soul Link uses Fantasy to create isolated temporary dimensions for each speedrun. Mods that:- Add custom portals
- Modify Nether/End portal behavior
- Change dimension loading/unloading
- Add new dimensions
World Generation Mods
While generally compatible, mods that significantly alter world generation may:- Change the difficulty of speedruns
- Affect structure spawning (strongholds, End portals)
- Impact performance during world creation
These mods usually work but may make speedruns easier or harder depending on generation changes.
Death Handling Mods
Avoid mods that:- Prevent player death
- Add respawn mechanics
- Modify death penalties
- Override death events
Compatible Mod Categories
The following types of mods are generally safe to use:Performance Mods
- Sodium
- Lithium
- Phosphor
- FerriteCore
Utility Mods
- Mod Menu
- REI (Roughly Enough Items)
- JEI (Just Enough Items)
- MiniHUD
Visual Mods
- Iris Shaders
- LambDynamicLights
- Continuity
- Visuality
Quality of Life
- Xaero’s Minimap
- Inventory sorting mods
- Chat mods
- Sound mods
Server vs Client
Soul Link Speedrun is a server-side mod. Players connecting to a server do NOT need to install it on their client.
- Vanilla clients
- Clients with client-side mods only
- Clients with Fabric Loader but no server-side mods
Hosting
| Environment | Compatibility | Notes |
|---|---|---|
| Dedicated Server | ✅ Fully supported | Recommended for multiplayer |
| Single-player | ✅ Fully supported | Works in local worlds |
| LAN Hosting | ✅ Fully supported | Host needs the mod installed |
| Essentials.gg | ✅ Fully supported | Only host needs the mod |
Testing Compatibility
If you’re unsure about a mod’s compatibility:Test in a development environment
Install both mods in a test environment before deploying to production.
Check for conflicts
Look for:
- Error messages in logs
- Unexpected behavior with shared health/hunger
- World generation issues
- Portal or dimension problems
Report issues
If you discover a compatibility issue, report it on the GitHub Issues page with:
- Both mod names and versions
- Fabric Loader and API versions
- Description of the conflict
- Logs if available
Dependency Resolution
The mod uses the Nucleoid Maven repository for the Fantasy dependency:build.gradle.