Getting Started

🎯 What is ChosenLib?

ChosenLib is a comprehensive utility library for Fabric modding, designed to help you build mods faster and with less boilerplate code. It provides essential utilities for common modding tasks, making your development process more efficient and enjoyable.

📋 Prerequisites

Before you start using ChosenLib, make sure you have the following installed:

🚀 Quick Overview

Here's what you can do with ChosenLib v1.6.0:

📂 FileUtils (NEW v1.6.0!)

// Read and write files
String content = FileUtils.readFile(Paths.get("config.txt"));
FileUtils.writeFile(Paths.get("data.json"), "{ \"key\": \"value\" }");

// Search for files
List jsonFiles = FileUtils.searchFiles(Paths.get("."), "*.json");

💻 Command Framework (NEW v1.6.0!)

// Create and register a command
public class MyCommand implements com.chosen.lib.command.Command {
    // ... register command logic
}
CommandManager.registerCommand(new MyCommand());

🔧 Advanced Block Operations (NEW v1.5.0!)

// Transactional block operations with safety
TransactionId transaction = AdvancedBlockOps.startTransaction(world);
AdvancedBlockOps.safeSetBlock(world, pos, newState);
AdvancedBlockOps.commitTransaction(transaction);

// Area operations with undo support
AdvancedBlockOps.fillArea(world, pos1, pos2, blockState);
AdvancedBlockOps.replaceInArea(world, pos1, pos2, fromState, toState);

🤖 Entity AI Utilities (NEW v1.5.0!)

// AI goal management
EntityAIUtils.addGoal(mob, new FollowPlayerGoal(), 1);
EntityAIUtils.setBehaviorState(mob, "aggressive");
EntityAIUtils.addMemory(mob, "lastPlayer", player);

// Custom behavior states
String state = EntityAIUtils.getBehaviorState(mob);
EntityAIUtils.clearGoals(mob);

💾 Data Persistence (NEW v1.5.0!)

// World and player data storage
DataPersistence.saveWorldData(world, "config", configData);
DataPersistence.savePlayerData(player, "stats", statsData);

// Data migration support
DataPersistence.migratePlayerData(playerId, "oldKey", "newKey");

✨ Effects & Particles (NEW v1.5.0!)

// Sound and particle effects
EffectsUtils.playSound(world, pos, sound, 1.0f, 1.0f);
EffectsUtils.spawnParticleSphere(world, particle, center, 2.0, 20);

// Delayed effects and sequences
EffectsUtils.playDelayedSound(world, pos, sound, 20);
EffectsUtils.createSoundSequence(sounds, delays);

🌐 Advanced Networking (fixed v1.5.1!)

// Sophisticated packet handling
AdvancedNetworking.createPacket("data", dataObject);
AdvancedNetworking.routePacket(channel, buffer, customRoute);

// Compression and encryption
AdvancedNetworking.compressPacket(buffer);
AdvancedNetworking.encryptPacket(buffer, "secret");

🌍 Custom Dimensions (NEW v1.5.0!)

// Dimension management
DimensionUtils.createDimension(dimensionId, dimensionType);
DimensionUtils.teleportToDimension(entity, dimensionId, pos);

// Portal systems
DimensionUtils.createPortal(world, pos, destination);
DimensionUtils.findPortal(world, dimensionId);

🔴 Redstone Automation (NEW v1.5.0!)

// Circuit analysis and logic gates
RedstoneUtils.analyzeCircuit(world, pos, 10);
RedstoneUtils.createANDGate(world, pos, inputs);
RedstoneUtils.simulateLogicGate(LogicGateType.OR, inputs);

📊 Performance Monitoring (NEW v1.5.0!)

// Built-in performance profiling
PerformanceMonitor.startProfiling("myOperation");
PerformanceMonitor.getMemoryUsage();
PerformanceMonitor.getTPSData(world);
PerformanceMonitor.generatePerformanceReport(world);

📝 Enhanced Existing Utilities

// Enhanced WorldUtils with transactional editing
WorldUtils.startTransaction(world);
WorldUtils.setBlockState(world, pos, newState);
WorldUtils.commitTransaction(transactionId);

// Enhanced EntityUtils with AI integration
EntityUtils.setAIEnabled(entity, true);
EntityUtils.addPathfindingGoal(entity, goal);

// Enhanced NetworkUtils with reliability
NetworkUtils.sendReliablePacket(player, channel, buffer);
NetworkUtils.enableCompression(channel);

📚 Learning Path

Follow this recommended learning path to get the most out of ChosenLib:

💡 Best Practices

Getting Started Tips

• Start Small: Begin with basic TextUtils functions before moving to more complex GUI utilities
• Check Compatibility: Ensure you're using the correct Minecraft and Fabric versions
• Read Documentation: Always refer to the API reference for method signatures and examples
• Test Regularly: Test your mod frequently to catch issues early

Common Pitfalls

• Client-side Code: Remember that GuiUtils is client-side only
• Version Compatibility: Use the correct ChosenLib version for your Minecraft version
• Dependencies: Make sure Fabric API is included in your mod

🔗 Resources

Additional resources to help you get started: