@@ -1,0 +1,115 @@
# Installing Huorn
Huorn is a Minecraft mod. Mods need a **mod loader** — a program that patches Minecraft to support mods. There are two loaders, and Huorn works with both.
## Pick a Loader
| | Fabric | Forge |
|--|--------|-------|
| **Vibe** | Lightweight, fast, modern | Old guard, huge mod ecosystem |
| **Install** | Tiny installer, downloads in seconds | Bigger installer, takes a minute |
| **Compatibility** | Needs Fabric API + Architectury API as separate mods | Needs Architectury API as a separate mod |
| **Recommendation** | **Use this one** unless you need Forge-only mods | Use if you already have a Forge setup |
## Install Fabric (Recommended)
1. **Download the Fabric installer** from https://fabricmc.net/use/installer/
2. Run it. Select Minecraft **1.20.1**, click Install.
3. Open the Minecraft Launcher. You'll see a new profile called **fabric-loader-1.20.1**. Don't launch it yet.
## Install Dependencies
Huorn needs two library mods. Download both for Minecraft 1.20.1:
- **Fabric API** — https://modrinth.com/mod/fabric-api (pick version for 1.20.1)
- **Architectury API** — https://modrinth.com/mod/architectury-api (pick Fabric version for 1.20.1)
Put both `.jar` files in your mods folder:
- **macOS:** `~/Library/Application Support/minecraft/mods/`
- **Linux:** `~/.minecraft/mods/`
- **Windows:** `%APPDATA%\.minecraft\mods\`
Create the `mods` folder if it doesn't exist.
## Install Huorn
Put `huorn-fabric-2026.03.1.jar` in the same `mods` folder.
Your mods folder should look like:
```
mods/
  fabric-api-0.91.0+1.20.1.jar
  architectury-9.2.14-fabric.jar
  huorn-fabric-2026.03.1.jar
```
## Launch
1. Open the Minecraft Launcher
2. Select the **fabric-loader-1.20.1** profile
3. Click Play
## In-Game
1. Create or join a world
2. Open chat (`T`) and type: `/give @s huorn:terminal_block`
3. Place the block, right-click it
4. You now have a terminal. Type commands.
5. **ESC** to stop typing and move around
6. **F12** for full-screen terminal overlay
7. Right-click again to resume typing
## Server Setup
For dedicated servers:
1. Install Fabric Server (same installer, check "Server" instead of "Client")
2. Put the same three JARs in the server's `mods/` folder
3. Edit `config/huorn.json`:
   ```json
   {
     "server": {
       "enableOnServers": true
     }
   }
   ```
4. Players need the `huorn.use` permission (ops have it by default, or use LuckPerms)
### Docker Backend (Optional)
To run terminal shells inside Docker containers instead of directly on the server:
1. Ensure Docker is running on the server
2. Pull the image: `docker pull ubuntu:24.04`
3. Edit `config/huorn.json`:
   ```json
   {
     "backends": {
       "docker": {
         "enabled": true
       }
     },
     "server": {
       "defaultBackend": "docker"
     }
   }
   ```
4. Grant players: `huorn.use.docker` permission
### Admin Commands
```
/huorn status              — show active terminals and backend availability
/huorn list                — show who has terminals open
/huorn kill <player|all>   — force-close terminals
/huorn reload              — reload config without restart
/huorn audit [player]      — view recent audit log entries
```
## If Using Forge Instead
Same process, but:
- Download the **Forge installer** from https://files.minecraftforge.net/ (version 47.2.0+ for 1.20.1)
- Download the **Forge** version of Architectury API from Modrinth
- You don't need Fabric API
- Use `huorn-forge-2026.03.1.jar` instead