📋 Prerequisites
Before installing ChosenLib, make sure you have:
- Fabric Loader - Latest version for your Minecraft version
- Fabric API - Required dependency
- Java 21 - For development and building
- Gradle - Build system (included with Fabric template)
🎮 For Players (Mod Users)
If you want to use ChosenLib as a dependency in other mods:
1. Download the Mod
Download ChosenLib from one of these sources:
2. Install the Mod
- chosenlib-1.6.0.jar file
- Place it in your
mods/folder - Make sure you have Fabric API installed
- Start Minecraft with Fabric Loader
3. Verify Installation
Once in-game, type /chosenlib to see v1.6.0 version information, new features, and interactive demos. Try the new subcommands:
/chosenlib demo- Interactive feature demonstrations/chosenlib perf- Real-time performance monitoring/chosenlib stats- Comprehensive statistics overview/chosenlib report- Detailed performance analysis
👨💻 For Developers (Mod Creators)
Add ChosenLib as a dependency in your mod project:
1. Add Repository
Add the repository to your build.gradle:
repositories {
mavenCentral()
maven { url = 'https://maven.fabricmc.net/' }
// Add your repository here when published
}
2. Add Dependency
Add ChosenLib as a dependency:
dependencies {
modImplementation "com.yourgroup:chosenlib:1.6.0"
// For development, you might also want:
modRuntimeOnly "com.yourgroup:chosenlib:1.6.0"
}
3. Update Your Mod
In your main mod class, add ChosenLib as a dependency:
@Mod("yourmodid")
public class YourMod implements ModInitializer {
@Override
public void onInitialize() {
// Your mod initialization code
LOGGER.info("Your mod is loading with ChosenLib v1.6.0 support!");
}
}
4. Import Utilities
Now you can import and use all ChosenLib v1.6.0 utilities:
// NEW in v1.6.0
import com.chosen.lib.util.FileUtils;
import com.chosen.lib.command.Command;
import com.chosen.lib.command.CommandManager;
// NEW in v1.5.0
import com.chosen.lib.util.AdvancedBlockOps;
import com.chosen.lib.util.EntityAIUtils;
import com.chosen.lib.util.DataPersistence;
import com.chosen.lib.util.EffectsUtils;
import com.chosen.lib.util.AdvancedNetworking;
import com.chosen.lib.util.DimensionUtils;
import com.chosen.lib.util.RedstoneUtils;
import com.chosen.lib.util.PerformanceMonitor;
// Enhanced existing utilities
import com.chosen.lib.util.WorldUtils;
import com.chosen.lib.util.EntityUtils;
import com.chosen.lib.util.NetworkUtils;
import com.chosen.lib.util.TextUtils;
import com.chosen.lib.util.GuiUtils;
import com.chosen.lib.util.ItemUtils;
// Use the new v1.6.0 utilities
FileUtils.writeFile(Paths.get("my-file.txt"), "Hello, world!");
CommandManager.registerCommand(new MyCommand());
TextUtils.success("ChosenLib v1.6.0 is working with new features!");
🔧 Building from Source
If you want to build ChosenLib from source:
1. Clone the Repository
git clone https://github.com/yourusername/chosenlib.git
cd chosenlib
2. Build the Project
./gradlew build
3. Find the Artifacts
The built JAR files will be in build/libs/:
chosenlib-1.6.0.jar- Use this for distributionchosenlib-1.6.0-sources.jar- Source codechosenlib-1.6.0-dev.jar- Development version
⚠️ Troubleshooting
Common Issues
| Issue | Solution |
|---|---|
| Mod not loading | Make sure you have Fabric API installed and are using the correct Minecraft version |
| Compilation errors | Check that you're using Java 21 and have the correct dependency version |
| GuiUtils not found | GuiUtils is client-side only. Make sure you're importing it in client-side code |
| Command not working | Ensure the mod is properly installed and you're using the correct command: /chosenlib |
Getting Help
If you're still having issues:
- Check the GitHub Issues page
- Join our Discord for support
- Review the API Reference for usage examples
📦 Version Compatibility
| ChosenLib Version | Minecraft Version | Fabric Loader | Java Version |
|---|---|---|---|
| 1.6.0 | 1.21.1 | 0.17.2+ | 21+ |
| 1.5.x | 1.21.1 | 0.17.2+ | 21+ |
| 1.4.0 | 1.21.1 | 0.17.2+ | 21+ |
| 1.2.x | 1.21.1 | 0.17.2+ | 21+ |
| 1.1.x | 1.21.1 | 0.17.2+ | 21+ |
🎉 Important: Always use the latest stable version (currently v1.6.0) for production mods. This version includes new features like FileUtils and a Command Framework. All features are production-ready with comprehensive documentation. Check our changelog for detailed information about all new features.