@bobschlowinskii/clicraft 0.4.0

package/docs/commands/create.md

@@ -0,0 +1,276 @@
+---
+layout: default
+title: create
+parent: Commands
+nav_order: 1
+description: "Create a new Minecraft instance"
+permalink: /commands/create
+---
+
+# create Command
+
+Create a new Minecraft instance with your choice of mod loader (Fabric or Forge).
+
+## 📝 Synopsis
+
+```bash
+clicraft create [options]
+```
+
+## 📖 Description
+
+The `create` command guides you through an interactive process to set up a new Minecraft instance. It will:
+
+1. Prompt you for instance configuration (name, type, loader, versions)
+2. Download the Minecraft client or server files
+3. Download the selected mod loader (Fabric or Forge)
+4. Download all required libraries and dependencies
+5. Download game assets (for client instances)
+6. Set up the directory structure
+7. Generate configuration files
+
+### Creating from Existing Config
+
+If you run `clicraft create` in a directory containing an `mcconfig.json` file, CLIcraft will automatically:
+
+1. Detect the existing configuration
+2. Display the config details for confirmation
+3. Prompt for a new instance name
+4. Create the instance with the same Minecraft version, mod loader, and loader version
+5. Install all mods from the configuration
+6. Apply game settings (if present in the config)
+
+This is perfect for sharing modpack configurations or replicating setups across machines.
+
+## 🎯 Options
+
+| Option | Description |
+|--------|-------------|
+| `--verbose` | Enable verbose output to see detailed progress |
+
+## 💡 Interactive Prompts
+
+When you run `clicraft create`, you'll be prompted for:
+
+### 1. Instance Name
+The name for your instance directory. This will be used as the folder name.
+- Must be a valid directory name
+- Should be descriptive (e.g., "vanilla-1.21", "modded-fabric-latest")
+
+### 2. Instance Type
+Choose between:
+- **Client** - For playing Minecraft yourself
+- **Server** - For hosting a multiplayer server
+
+### 3. Mod Loader
+Choose your mod loader:
+- **Fabric** - Lightweight, fast, modern mod loader
+- **Forge** - Traditional, widely-supported mod loader
+
+### 4. Minecraft Version
+Select the Minecraft version you want to use. Common choices:
+- Latest release (e.g., 1.21.1)
+- Stable versions with good mod support (e.g., 1.20.1, 1.19.2)
+- Specific version for mod compatibility
+
+### 5. Loader Version
+Choose the version of your selected mod loader:
+- Latest version (recommended for most users)
+- Specific version for compatibility
+
+## 📂 Instance Structure
+
+After creation, your instance will have this structure:
+
+```
+my-instance/
+├── mcconfig.json      # Instance configuration
+├── launch.sh          # Generated launch script (reference)
+├── assets/            # Game assets (sounds, textures, etc.)
+├── libraries/         # Java libraries and dependencies
+├── mods/              # Installed mods (empty initially)
+├── natives/           # Native libraries (platform-specific)
+├── versions/          # Version JARs and JSON metadata
+├── saves/             # World saves (created when you play)
+├── resourcepacks/     # Resource packs
+└── logs/              # Game logs
+```
+
+## 📋 Examples
+
+### Basic usage
+```bash
+clicraft create
+```
+
+Then follow the interactive prompts.
+
+### Verbose output
+```bash
+clicraft create --verbose
+```
+
+See detailed progress as files are downloaded and configured.
+
+## 🎮 Example Session
+
+```bash
+$ clicraft create
+
+? Enter instance name: my-modded-world
+? Select instance type: Client
+? Select mod loader: Fabric
+? Select Minecraft version: 1.21.1
+? Select Fabric version: 0.16.5
+
+Creating instance my-modded-world...
+✓ Downloading Minecraft 1.21.1...
+✓ Downloading Fabric loader 0.16.5...
+✓ Downloading libraries...
+✓ Downloading assets...
+✓ Creating directory structure...
+✓ Writing configuration...
+
+Instance created successfully at: ./my-modded-world
+
+Next steps:
+  cd my-modded-world
+  clicraft login              # Login to Microsoft account
+  clicraft install <mod>      # Install mods
+  clicraft launch             # Launch the game
+```
+
+## 🔍 What Happens Behind the Scenes
+
+1. **Manifest Download**: Fetches the Minecraft version manifest from Mojang
+2. **Version Selection**: Downloads specific version metadata
+3. **Loader Setup**: Downloads and configures Fabric or Forge
+4. **Library Resolution**: Downloads all required Java libraries
+5. **Asset Download**: Fetches game assets (textures, sounds, language files)
+6. **Native Libraries**: Downloads platform-specific native libraries
+7. **Configuration**: Creates `mcconfig.json` with all instance settings
+
+## ⚙️ Configuration File
+
+The created `mcconfig.json` contains:
+
+```json
+{
+  "name": "my-instance",
+  "type": "client",
+  "loader": "fabric",
+  "minecraftVersion": "1.21.1",
+  "loaderVersion": "0.16.5",
+  "javaPath": "java",
+  "jvmArgs": ["-Xmx2G", "-Xms2G"]
+}
+```
+
+You can manually edit this file to customize Java settings and other configurations.
+
+## 🎯 Use Cases
+
+### Development Environment
+```bash
+# Create a clean testing environment
+clicraft create
+# Name: mod-testing
+# Type: Client
+# Loader: Fabric
+# Version: Latest
+```
+
+### Server Setup
+```bash
+# Create a multiplayer server
+clicraft create
+# Name: survival-server
+# Type: Server
+# Loader: Forge
+# Version: 1.20.1
+```
+
+### Multiple Instances
+```bash
+# Create separate instances for different mod packs
+clicraft create  # vanilla-survival
+clicraft create  # tech-mods
+clicraft create  # creative-building
+```
+
+### Create from Shared Config
+```bash
+# Someone shared their mcconfig.json with you
+mkdir my-new-instance
+cd my-new-instance
+cp ~/Downloads/mcconfig.json .
+
+# Create instance from the config
+clicraft create
+# CLIcraft detects the config and offers to create from it
+```
+
+### Clone an Existing Instance
+```bash
+# Copy just the config (not the whole instance)
+cp my-instance/mcconfig.json ~/new-instance-config/
+cd ~/new-instance-config/
+
+# Create a fresh instance with same mods and settings
+clicraft create
+```
+
+## ⚠️ Common Issues
+
+### Download Failures
+If downloads fail:
+- Check your internet connection
+- Try again - downloads will resume from where they left off
+- Use `--verbose` to see detailed error messages
+
+### Disk Space
+Creating an instance requires:
+- **Client**: ~500MB - 2GB depending on version
+- **Server**: ~50MB - 500MB depending on version
+
+Make sure you have sufficient disk space available.
+
+### Java Version
+Ensure you have Java 21 or higher installed:
+```bash
+java --version
+```
+
+## 🆘 Troubleshooting
+
+### "Failed to download Minecraft version manifest"
+This usually indicates a network issue. Check your internet connection and try again.
+
+### "Unsupported Minecraft version"
+The version you selected may not be supported by the chosen mod loader. Try:
+- A more recent version
+- Checking the mod loader's supported versions
+
+### Permission Errors
+On Linux/macOS, ensure you have write permissions in the current directory:
+```bash
+ls -la
+```
+
+## 📚 Related Commands
+
+After creating an instance:
+- [`clicraft install`](install.md) - Install mods to your new instance
+- [`clicraft login`](login.md) - Login for online play
+- [`clicraft launch`](launch.md) - Start your instance
+- [`clicraft info`](info.md) - View instance details
+
+## 🔗 See Also
+
+- [Installation Guide](../installation.md)
+- [Commands Overview](../commands.md)
+- [Configuration Guide](../configuration.md)
+
+---
+
+[← Back to Commands](../commands.md) | [Next: search →](search.md)

package/docs/commands/info.md

@@ -0,0 +1,460 @@
+---
+layout: default
+title: info
+parent: Commands
+nav_order: 6
+description: "View instance information"
+permalink: /commands/info
+---
+
+# info Command
+
+View detailed information about your Minecraft instance.
+
+## 📝 Synopsis
+
+```bash
+clicraft info [options]
+```
+
+## 📖 Description
+
+The `info` command displays comprehensive information about your Minecraft instance, including:
+
+- Instance configuration
+- Installed mods and their versions
+- Storage usage breakdown
+- World saves
+- Resource packs
+- Minecraft and loader versions
+
+This is useful for checking what's installed, troubleshooting issues, or getting an overview of your instance.
+
+## 🎯 Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-i, --instance <path>` | Path to instance directory | Current directory |
+| `--verbose` | Show detailed information | false |
+
+## 📋 Examples
+
+### View basic info
+```bash
+cd my-instance
+clicraft info
+```
+
+### View detailed info
+```bash
+clicraft info --verbose
+```
+
+### Check specific instance
+```bash
+clicraft info --instance ./my-modded-world
+```
+
+### Quick instance check
+```bash
+clicraft info --instance ~/minecraft/server
+```
+
+## 🎮 Example Output
+
+### Basic Mode
+```bash
+$ cd my-instance
+$ clicraft info
+
+Instance: my-modded-world
+Type: Client
+Minecraft: 1.21.1
+Loader: Fabric 0.16.5
+
+Installed Mods (5):
+  - Sodium 0.6.0
+  - Lithium 0.12.0
+  - Iris Shaders 1.8.0
+  - Fabric API 0.100.0
+  - Mod Menu 9.0.0
+
+Storage Usage:
+  Total: 1.2 GB
+  Mods: 45 MB
+  Assets: 650 MB
+  Libraries: 480 MB
+  Saves: 25 MB
+
+World Saves (2):
+  - New World (15 MB)
+  - Creative Testing (10 MB)
+```
+
+### Verbose Mode
+```bash
+$ clicraft info --verbose
+
+════════════════════════════════════════
+         Instance Information
+════════════════════════════════════════
+
+Name:              my-modded-world
+Type:              Client
+Location:          /home/user/my-modded-world
+Minecraft Version: 1.21.1
+Mod Loader:        Fabric 0.16.5
+Java Path:         /usr/bin/java
+Java Version:      21.0.1
+
+════════════════════════════════════════
+              Mods (5)
+════════════════════════════════════════
+
+1. Sodium (sodium)
+   Version: 0.6.0-beta.2+mc1.21.1
+   File: sodium-fabric-0.6.0.jar
+   Size: 1.2 MB
+
+2. Lithium (lithium)
+   Version: 0.12.0
+   File: lithium-fabric-mc1.21.1-0.12.0.jar
+   Size: 856 KB
+
+3. Iris Shaders (iris)
+   Version: 1.8.0
+   File: iris-mc1.21.1-1.8.0.jar
+   Size: 3.4 MB
+
+4. Fabric API (fabric-api)
+   Version: 0.100.0+1.21.1
+   File: fabric-api-0.100.0+1.21.1.jar
+   Size: 5.2 MB
+
+5. Mod Menu (modmenu)
+   Version: 9.0.0
+   File: modmenu-9.0.0.jar
+   Size: 680 KB
+
+════════════════════════════════════════
+           Storage Usage
+════════════════════════════════════════
+
+Total Size:        1.2 GB
+├─ Assets:         650 MB (54%)
+├─ Libraries:      480 MB (40%)
+├─ Mods:           45 MB (4%)
+├─ Saves:          25 MB (2%)
+├─ Resource Packs: 0 MB (0%)
+└─ Other:          10 MB (1%)
+
+════════════════════════════════════════
+           World Saves (2)
+════════════════════════════════════════
+
+1. New World
+   Size: 15 MB
+   Last Played: 2024-01-15 14:30:00
+   Game Mode: Survival
+
+2. Creative Testing
+   Size: 10 MB
+   Last Played: 2024-01-14 18:45:00
+   Game Mode: Creative
+
+════════════════════════════════════════
+          Resource Packs (0)
+════════════════════════════════════════
+
+No resource packs installed.
+
+════════════════════════════════════════
+           Configuration
+════════════════════════════════════════
+
+JVM Arguments:
+  -Xmx2G
+  -Xms2G
+
+Game Directory:
+  /home/user/my-modded-world
+
+════════════════════════════════════════
+```
+
+## 🔍 Information Breakdown
+
+### Instance Details
+- **Name**: Instance identifier
+- **Type**: Client or Server
+- **Location**: Full path to instance directory
+- **Minecraft Version**: Version of Minecraft
+- **Mod Loader**: Loader type and version
+- **Java**: Java path and version
+
+### Mod Information
+For each installed mod:
+- Mod name
+- Version
+- File name
+- File size
+
+### Storage Usage
+Disk space used by:
+- **Assets**: Game assets (textures, sounds)
+- **Libraries**: Java dependencies
+- **Mods**: Installed mod files
+- **Saves**: World save files
+- **Resource Packs**: Custom resource packs
+- **Other**: Logs, configs, etc.
+
+### World Saves
+For each world:
+- World name
+- Size on disk
+- Last played date/time
+- Game mode (Survival/Creative/Adventure)
+
+### Resource Packs
+Lists installed resource packs with:
+- Pack name
+- Pack version
+- File size
+
+## 🎯 Use Cases
+
+### Check Installed Mods
+```bash
+cd my-instance
+clicraft info | grep -A 20 "Installed Mods"
+```
+
+### Verify Instance Configuration
+```bash
+clicraft info --verbose | grep -A 5 "Instance Information"
+```
+
+### Check Storage Usage
+```bash
+clicraft info | grep -A 10 "Storage Usage"
+```
+
+### List All Worlds
+```bash
+clicraft info | grep -A 20 "World Saves"
+```
+
+### Compare Multiple Instances
+```bash
+clicraft info --instance ./instance1 > inst1.txt
+clicraft info --instance ./instance2 > inst2.txt
+diff inst1.txt inst2.txt
+```
+
+### Pre-Launch Check
+```bash
+# Check everything is set up correctly
+clicraft info --verbose
+clicraft status
+clicraft launch
+```
+
+## 📊 Interpreting Output
+
+### Mod Count
+- **0-10 mods**: Light modpack
+- **10-50 mods**: Medium modpack  
+- **50-100 mods**: Heavy modpack
+- **100+ mods**: Very heavy modpack
+
+Consider allocating more RAM for larger modpacks.
+
+### Storage Usage
+- **Assets**: 400-800 MB is normal
+- **Libraries**: 200-600 MB is normal
+- **Mods**: Depends on mod count
+- **Saves**: Grows with gameplay time
+
+### Large Saves
+If world saves are large (>1 GB):
+- Consider backing up
+- May slow down loading
+- Can be archived if not actively used
+
+## 💡 Troubleshooting with info
+
+### Missing Mods
+If expected mods don't appear:
+```bash
+clicraft info
+# Check mod list
+
+# Reinstall if missing
+clicraft install missing-mod
+```
+
+### Wrong Version
+Check versions match:
+```bash
+clicraft info --verbose
+# Verify Minecraft and loader versions
+
+# Update if needed
+clicraft upgrade
+```
+
+### High Storage Usage
+Identify large files:
+```bash
+clicraft info --verbose
+# Check storage breakdown
+
+# Clean up old worlds or logs
+cd my-instance
+rm -rf saves/old-world
+rm -rf logs/*.log.gz
+```
+
+### Before Reporting Issues
+Always include output of:
+```bash
+clicraft info --verbose > instance-info.txt
+```
+
+## 📁 Directory Inspection
+
+The info command analyzes:
+```
+instance-directory/
+├── mcconfig.json      # Configuration
+├── mods/              # Scanned for mods
+├── saves/             # Scanned for worlds
+├── resourcepacks/     # Scanned for packs
+├── assets/            # Measured for size
+├── libraries/         # Measured for size
+├── versions/          # Version info
+└── logs/              # Included in "Other"
+```
+
+## ⚙️ Configuration Display
+
+### JVM Arguments
+Shows memory allocation and other Java settings:
+```
+JVM Arguments:
+  -Xmx4G           # Max memory: 4GB
+  -Xms4G           # Initial memory: 4GB
+  -XX:+UseG1GC     # Garbage collector
+```
+
+### Java Detection
+Shows which Java will be used:
+```
+Java Path:    /usr/bin/java
+Java Version: 21.0.1
+```
+
+Verify this matches your requirements.
+
+## 🔄 Real-Time Information
+
+The info command shows current state:
+- Installed mods **right now**
+- Current storage usage
+- Existing world saves
+- Current configuration
+
+Run `clicraft info` after:
+- Installing/removing mods
+- Playing and creating worlds
+- Changing configuration
+- Updating versions
+
+## ⚠️ Common Issues
+
+### "Instance not found"
+Ensure you're in an instance directory:
+```bash
+ls mcconfig.json
+
+# Or specify path
+clicraft info --instance ./my-instance
+```
+
+### "Cannot read mods"
+Check permissions:
+```bash
+ls -la mods/
+chmod 644 mods/*.jar
+```
+
+### "Storage calculation failed"
+May happen if directories are inaccessible:
+```bash
+ls -la
+# Check directory permissions
+```
+
+### Mods Not Showing
+If mods are installed but not listed:
+- Check `mods/` directory exists
+- Verify `.jar` files are present
+- Check file permissions
+
+```bash
+ls -la mods/
+```
+
+## 💡 Pro Tips
+
+1. **Regular Checks**: Run `clicraft info` periodically to monitor your instance
+2. **Before Updates**: Check current state before upgrading
+3. **Disk Space**: Monitor storage usage to avoid filling up disk
+4. **Verbose Mode**: Use `--verbose` for complete details
+5. **Backup Reference**: Save `clicraft info --verbose` output before major changes
+6. **Mod Lists**: Use info to create mod lists for sharing
+7. **Performance**: Large mod counts = more RAM needed
+
+## 📋 Creating Mod Lists
+
+Export your mod list:
+```bash
+clicraft info > modlist.txt
+
+# Or just the mods section
+clicraft info | grep -A 100 "Installed Mods" > mods.txt
+```
+
+Share with friends or for documentation.
+
+## 🔍 Automation
+
+Use in scripts:
+```bash
+#!/bin/bash
+# Check if instance is ready
+if clicraft info --instance "$INSTANCE" | grep -q "Installed Mods"; then
+    echo "Instance is valid"
+    clicraft launch --instance "$INSTANCE"
+else
+    echo "Instance has issues"
+    exit 1
+fi
+```
+
+## 📚 Related Commands
+
+- [`clicraft create`](create.md) - Create the instance to inspect
+- [`clicraft install`](install.md) - Install mods (shown in info)
+- [`clicraft upgrade`](upgrade.md) - Update versions (check with info)
+- [`clicraft launch`](launch.md) - Launch after verifying with info
+
+## 🔗 See Also
+
+- [Commands Overview](../commands.md)
+- [Configuration Guide](../configuration.md)
+- [Upgrade Command](upgrade.md)
+
+---
+
+[← Back to Commands](../commands.md) | [Next: upgrade →](upgrade.md)