mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-05 02:07:34 +08:00
Broad drift audit against origin/main (b52b63396).
Reference pages (most user-visible drift):
- slash-commands: add /busy, /curator, /footer, /indicator, /redraw, /steer
that were missing; drop non-existent /terminal-setup; fix /q footnote
(resolves to /queue, not /quit); extend CLI-only list with all 24
CLI-only commands in the registry
- cli-commands: add dedicated sections for hermes curator / fallback /
hooks (new subcommands not previously documented); remove stale
hermes honcho standalone section (the plugin registers dynamically
via hermes memory); list curator/fallback/hooks in top-level table;
fix completion to include fish
- toolsets-reference: document the real 52-toolset count; split browser
vs browser-cdp; add discord / discord_admin / spotify / yuanbao;
correct hermes-cli tool count from 36 to 38; fix misleading claim
that hermes-homeassistant adds tools (it's identical to hermes-cli)
- tools-reference: bump tool count 55 -> 68; add 7 Spotify, 5 Yuanbao,
2 Discord toolsets; move browser_cdp/browser_dialog to their own
browser-cdp toolset section
- environment-variables: add 40+ user-facing HERMES_* vars that were
undocumented (--yolo, --accept-hooks, --ignore-*, inference model
override, agent/stream/checkpoint timeouts, OAuth trace, per-platform
batch tuning for Telegram/Discord/Matrix/Feishu/WeCom, cron knobs,
gateway restart/connect timeouts); dedupe the Cron Scheduler section;
replace stale QQ_SANDBOX with QQ_PORTAL_HOST
User-guide (top level):
- cli.md: compression preserves last 20 turns, not 4 (protect_last_n: 20)
- configuration.md: display.platforms is the canonical per-platform
override key; tool_progress_overrides is deprecated and auto-migrated
- profiles.md: model.default is the config key, not model.model
- sessions.md: CLI/TUI session IDs use 6-char hex, gateway uses 8
- checkpoints-and-rollback.md: destructive-command list now matches
_DESTRUCTIVE_PATTERNS (adds rmdir, cp, install, dd)
- docker.md: the container runs as non-root hermes (UID 10000) via
gosu; fix install command (uv pip); add missing --insecure on the
dashboard compose example (required for non-loopback bind)
- security.md: systemctl danger pattern also matches 'restart'
- index.md: built-in tool count 47 -> 68
- integrations/index.md: 6 STT providers, 8 memory providers
- integrations/providers.md: drop fictional dashscope/qwen aliases
Features:
- overview.md: 9 image models (not 8), 9 TTS providers (not 5),
8 memory providers (Supermemory was missing)
- tool-gateway.md: 9 image models
- tools.md: extend common-toolsets list with search / messaging /
spotify / discord / debugging / safe
- fallback-providers.md: add 6 real providers from PROVIDER_REGISTRY
(lmstudio, kimi-coding-cn, stepfun, alibaba-coding-plan,
tencent-tokenhub, azure-foundry)
- plugins.md: Available Hooks table now includes on_session_finalize,
on_session_reset, subagent_stop
- built-in-plugins.md: add the 7 bundled plugins the page didn't
mention (spotify, google_meet, three image_gen providers, two
dashboard examples)
- web-dashboard.md: add --insecure and --tui flags
- cron.md: hermes cron create takes positional schedule/prompt, not
flags
Messaging:
- telegram.md: TELEGRAM_WEBHOOK_SECRET is now REQUIRED when
TELEGRAM_WEBHOOK_URL is set (gateway refuses to start without it
per GHSA-3vpc-7q5r-276h). Biggest user-visible drift in the batch.
- discord.md: HERMES_DISCORD_TEXT_BATCH_SPLIT_DELAY_SECONDS default
is 2.0, not 0.1
- dingtalk.md: document DINGTALK_REQUIRE_MENTION /
FREE_RESPONSE_CHATS / MENTION_PATTERNS / HOME_CHANNEL /
ALLOW_ALL_USERS that the adapter supports
- bluebubbles.md: drop fictional BLUEBUBBLES_SEND_READ_RECEIPTS env
var; the setting lives in platforms.bluebubbles.extra only
- qqbot.md: drop dead QQ_SANDBOX; add real QQ_PORTAL_HOST and
QQ_GROUP_ALLOWED_USERS
- wecom-callback.md: replace 'hermes gateway start' (service-only)
with 'hermes gateway' for first-time setup
Developer-guide:
- architecture.md: refresh tool/toolset counts (61/52), terminal
backend count (7), line counts for run_agent.py (~13.7k), cli.py
(~11.5k), main.py (~10.4k), setup.py (~3.5k), gateway/run.py
(~12.2k), mcp_tool.py (~3.1k); add yuanbao adapter, bump platform
adapter count 18 -> 20
- agent-loop.md: run_agent.py line count 10.7k -> 13.7k
- tools-runtime.md: add vercel_sandbox backend
- adding-tools.md: remove stale 'Discovery import added to
model_tools.py' checklist item (registry auto-discovery)
- adding-platform-adapters.md: mark send_typing / get_chat_info as
concrete base methods; only connect/disconnect/send are abstract
- acp-internals.md: ACP sessions now persist to SessionDB
(~/.hermes/state.db); acp.run_agent call uses
use_unstable_protocol=True
- cron-internals.md: gateway runs scheduler in a dedicated background
thread via _start_cron_ticker, not on a maintenance cycle; locking
is cross-process via fcntl.flock (Unix) / msvcrt.locking (Windows)
- gateway-internals.md: gateway/run.py ~12k lines
- provider-runtime.md: cron DOES support fallback (run_job reads
fallback_providers from config)
- session-storage.md: SCHEMA_VERSION = 11 (not 9); add migrations
10 and 11 (trigram FTS, inline-mode FTS5 re-index); add
api_call_count column to Sessions DDL; document messages_fts_trigram
and state_meta in the architecture tree
- context-compression-and-caching.md: remove the obsolete 'context
pressure warnings' section (warnings were removed for causing
models to give up early)
- context-engine-plugin.md: compress() signature now includes
focus_topic param
- extending-the-cli.md: _build_tui_layout_children signature now
includes model_picker_widget; add to default layout
Also fixed three pre-existing broken links/anchors the build warned
about (docker.md -> api-server.md, yuanbao.md -> cron-jobs.md and
tips#background-tasks, nix-setup.md -> #container-aware-cli).
Regenerated per-skill pages via website/scripts/generate-skill-docs.py
so catalog tables and sidebar are consistent with current SKILL.md
frontmatter.
docusaurus build: clean, no broken links or anchors.
206 lines
7.0 KiB
Markdown
206 lines
7.0 KiB
Markdown
---
|
|
title: "Minecraft Modpack Server — Host modded Minecraft servers (CurseForge, Modrinth)"
|
|
sidebar_label: "Minecraft Modpack Server"
|
|
description: "Host modded Minecraft servers (CurseForge, Modrinth)"
|
|
---
|
|
|
|
{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}
|
|
|
|
# Minecraft Modpack Server
|
|
|
|
Host modded Minecraft servers (CurseForge, Modrinth).
|
|
|
|
## Skill metadata
|
|
|
|
| | |
|
|
|---|---|
|
|
| Source | Bundled (installed by default) |
|
|
| Path | `skills/gaming/minecraft-modpack-server` |
|
|
|
|
## Reference: full SKILL.md
|
|
|
|
:::info
|
|
The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active.
|
|
:::
|
|
|
|
# Minecraft Modpack Server Setup
|
|
|
|
## When to use
|
|
- User wants to set up a modded Minecraft server from a server pack zip
|
|
- User needs help with NeoForge/Forge server configuration
|
|
- User asks about Minecraft server performance tuning or backups
|
|
|
|
## Gather User Preferences First
|
|
Before starting setup, ask the user for:
|
|
- **Server name / MOTD** — what should it say in the server list?
|
|
- **Seed** — specific seed or random?
|
|
- **Difficulty** — peaceful / easy / normal / hard?
|
|
- **Gamemode** — survival / creative / adventure?
|
|
- **Online mode** — true (Mojang auth, legit accounts) or false (LAN/cracked friendly)?
|
|
- **Player count** — how many players expected? (affects RAM & view distance tuning)
|
|
- **RAM allocation** — or let agent decide based on mod count & available RAM?
|
|
- **View distance / simulation distance** — or let agent pick based on player count & hardware?
|
|
- **PvP** — on or off?
|
|
- **Whitelist** — open server or whitelist only?
|
|
- **Backups** — want automated backups? How often?
|
|
|
|
Use sensible defaults if the user doesn't care, but always ask before generating the config.
|
|
|
|
## Steps
|
|
|
|
### 1. Download & Inspect the Pack
|
|
```bash
|
|
mkdir -p ~/minecraft-server
|
|
cd ~/minecraft-server
|
|
wget -O serverpack.zip "<URL>"
|
|
unzip -o serverpack.zip -d server
|
|
ls server/
|
|
```
|
|
Look for: `startserver.sh`, installer jar (neoforge/forge), `user_jvm_args.txt`, `mods/` folder.
|
|
Check the script to determine: mod loader type, version, and required Java version.
|
|
|
|
### 2. Install Java
|
|
- Minecraft 1.21+ → Java 21: `sudo apt install openjdk-21-jre-headless`
|
|
- Minecraft 1.18-1.20 → Java 17: `sudo apt install openjdk-17-jre-headless`
|
|
- Minecraft 1.16 and below → Java 8: `sudo apt install openjdk-8-jre-headless`
|
|
- Verify: `java -version`
|
|
|
|
### 3. Install the Mod Loader
|
|
Most server packs include an install script. Use the INSTALL_ONLY env var to install without launching:
|
|
```bash
|
|
cd ~/minecraft-server/server
|
|
ATM10_INSTALL_ONLY=true bash startserver.sh
|
|
# Or for generic Forge packs:
|
|
# java -jar forge-*-installer.jar --installServer
|
|
```
|
|
This downloads libraries, patches the server jar, etc.
|
|
|
|
### 4. Accept EULA
|
|
```bash
|
|
echo "eula=true" > ~/minecraft-server/server/eula.txt
|
|
```
|
|
|
|
### 5. Configure server.properties
|
|
Key settings for modded/LAN:
|
|
```properties
|
|
motd=\u00a7b\u00a7lServer Name \u00a7r\u00a78| \u00a7aModpack Name
|
|
server-port=25565
|
|
online-mode=true # false for LAN without Mojang auth
|
|
enforce-secure-profile=true # match online-mode
|
|
difficulty=hard # most modpacks balance around hard
|
|
allow-flight=true # REQUIRED for modded (flying mounts/items)
|
|
spawn-protection=0 # let everyone build at spawn
|
|
max-tick-time=180000 # modded needs longer tick timeout
|
|
enable-command-block=true
|
|
```
|
|
|
|
Performance settings (scale to hardware):
|
|
```properties
|
|
# 2 players, beefy machine:
|
|
view-distance=16
|
|
simulation-distance=10
|
|
|
|
# 4-6 players, moderate machine:
|
|
view-distance=10
|
|
simulation-distance=6
|
|
|
|
# 8+ players or weaker hardware:
|
|
view-distance=8
|
|
simulation-distance=4
|
|
```
|
|
|
|
### 6. Tune JVM Args (user_jvm_args.txt)
|
|
Scale RAM to player count and mod count. Rule of thumb for modded:
|
|
- 100-200 mods: 6-12GB
|
|
- 200-350+ mods: 12-24GB
|
|
- Leave at least 8GB free for the OS/other tasks
|
|
|
|
```
|
|
-Xms12G
|
|
-Xmx24G
|
|
-XX:+UseG1GC
|
|
-XX:+ParallelRefProcEnabled
|
|
-XX:MaxGCPauseMillis=200
|
|
-XX:+UnlockExperimentalVMOptions
|
|
-XX:+DisableExplicitGC
|
|
-XX:+AlwaysPreTouch
|
|
-XX:G1NewSizePercent=30
|
|
-XX:G1MaxNewSizePercent=40
|
|
-XX:G1HeapRegionSize=8M
|
|
-XX:G1ReservePercent=20
|
|
-XX:G1HeapWastePercent=5
|
|
-XX:G1MixedGCCountTarget=4
|
|
-XX:InitiatingHeapOccupancyPercent=15
|
|
-XX:G1MixedGCLiveThresholdPercent=90
|
|
-XX:G1RSetUpdatingPauseTimePercent=5
|
|
-XX:SurvivorRatio=32
|
|
-XX:+PerfDisableSharedMem
|
|
-XX:MaxTenuringThreshold=1
|
|
```
|
|
|
|
### 7. Open Firewall
|
|
```bash
|
|
sudo ufw allow 25565/tcp comment "Minecraft Server"
|
|
```
|
|
Check with: `sudo ufw status | grep 25565`
|
|
|
|
### 8. Create Launch Script
|
|
```bash
|
|
cat > ~/start-minecraft.sh << 'EOF'
|
|
#!/bin/bash
|
|
cd ~/minecraft-server/server
|
|
java @user_jvm_args.txt @libraries/net/neoforged/neoforge/<VERSION>/unix_args.txt nogui
|
|
EOF
|
|
chmod +x ~/start-minecraft.sh
|
|
```
|
|
Note: For Forge (not NeoForge), the args file path differs. Check `startserver.sh` for the exact path.
|
|
|
|
### 9. Set Up Automated Backups
|
|
Create backup script:
|
|
```bash
|
|
cat > ~/minecraft-server/backup.sh << 'SCRIPT'
|
|
#!/bin/bash
|
|
SERVER_DIR="$HOME/minecraft-server/server"
|
|
BACKUP_DIR="$HOME/minecraft-server/backups"
|
|
WORLD_DIR="$SERVER_DIR/world"
|
|
MAX_BACKUPS=24
|
|
mkdir -p "$BACKUP_DIR"
|
|
[ ! -d "$WORLD_DIR" ] && echo "[BACKUP] No world folder" && exit 0
|
|
TIMESTAMP=$(date +%Y-%m-%d_%H-%M-%S)
|
|
BACKUP_FILE="$BACKUP_DIR/world_${TIMESTAMP}.tar.gz"
|
|
echo "[BACKUP] Starting at $(date)"
|
|
tar -czf "$BACKUP_FILE" -C "$SERVER_DIR" world
|
|
SIZE=$(du -h "$BACKUP_FILE" | cut -f1)
|
|
echo "[BACKUP] Saved: $BACKUP_FILE ($SIZE)"
|
|
BACKUP_COUNT=$(ls -1t "$BACKUP_DIR"/world_*.tar.gz 2>/dev/null | wc -l)
|
|
if [ "$BACKUP_COUNT" -gt "$MAX_BACKUPS" ]; then
|
|
REMOVE=$((BACKUP_COUNT - MAX_BACKUPS))
|
|
ls -1t "$BACKUP_DIR"/world_*.tar.gz | tail -n "$REMOVE" | xargs rm -f
|
|
echo "[BACKUP] Pruned $REMOVE old backup(s)"
|
|
fi
|
|
echo "[BACKUP] Done at $(date)"
|
|
SCRIPT
|
|
chmod +x ~/minecraft-server/backup.sh
|
|
```
|
|
|
|
Add hourly cron:
|
|
```bash
|
|
(crontab -l 2>/dev/null | grep -v "minecraft/backup.sh"; echo "0 * * * * $HOME/minecraft-server/backup.sh >> $HOME/minecraft-server/backups/backup.log 2>&1") | crontab -
|
|
```
|
|
|
|
## Pitfalls
|
|
- ALWAYS set `allow-flight=true` for modded — mods with jetpacks/flight will kick players otherwise
|
|
- `max-tick-time=180000` or higher — modded servers often have long ticks during worldgen
|
|
- First startup is SLOW (several minutes for big packs) — don't panic
|
|
- "Can't keep up!" warnings on first launch are normal, settles after initial chunk gen
|
|
- If online-mode=false, set enforce-secure-profile=false too or clients get rejected
|
|
- The pack's startserver.sh often has an auto-restart loop — make a clean launch script without it
|
|
- Delete the world/ folder to regenerate with a new seed
|
|
- Some packs have env vars to control behavior (e.g., ATM10 uses ATM10_JAVA, ATM10_RESTART, ATM10_INSTALL_ONLY)
|
|
|
|
## Verification
|
|
- `pgrep -fa neoforge` or `pgrep -fa minecraft` to check if running
|
|
- Check logs: `tail -f ~/minecraft-server/server/logs/latest.log`
|
|
- Look for "Done (Xs)!" in the log = server is ready
|
|
- Test connection: player adds server IP in Multiplayer
|