⚙️ EverMod CLI

EverMod CLI is the official command-line tool for the EverMod Framework. designed to simplify the creation and management of Minecraft Forge modding workspaces. It helps you initialize workspaces, create mods, manage templates, and generate documentation packs for analysis or AI-assisted refactoring.

---

✨ Features

• Initialize Forge modding workspaces
• Create new Forge mods from templates
• Add EverMod support to existing projects
• Manage multiple mods inside a single workspace
• Update global templates easily
• Generate ContextPack XML files with full project context

---

🧰 Installation

Download the installer for your platform from the Releases section:

Platform	Installer
🪟 Windows	EverMod-Setup.exe
🐧 Linux	EverMod-Setup.run
🍎 macOS	(coming soon)

After installation, open a terminal and run:

evermod update

This initializes your local EverMod template environment, preparing it for use.

---

🚀 Basic Usage

All commands follow this structure:

evermod <command> [options]

If no command is provided, EverMod will show the help menu.

---

🧩 Commands

init — Initialize a workspace

Creates a new workspace directory prepared to host multiple mods.

evermod init

Optional:

evermod init --path <directory>

You will be prompted for:

• Workspace name
• Whether to include EverMod as a Git submodule

---

create — Create a new mod

Creates a new Forge mod from templates.

evermod create

Optional:

evermod create --space <workspace-path>

You will be prompted for:

• Mod name and ID
• Minecraft version
• Author and package name
• Whether to include EverMod (for standalone mods)

If executed inside a workspace, the mod will be created under mods/ automatically.

---

add — Add EverMod to an existing project

Adds EverMod support to an existing mod or workspace.

evermod add

Optional:

evermod add --path <project-path>

This will:

• Detect the project type
• Update Gradle configuration
• Add EverMod as a Git submodule
• Generate an EverMod manifest

---

update — Update templates

Updates the global Forge templates used by EverMod.

evermod update

Options:

evermod update --force
evermod update --silent

• --force: reinstall templates even if already up to date
• --silent: run without prompts

---

contextpack — Generate ContextPack

Generates a single XML file containing the structure and contents of the project.

evermod contextpack

Optional:

evermod contextpack <target-path>

This is useful for:

• Documentation
• Debugging
• Sharing project context with AI tools

A configuration file (ContextPack.config.json) can be used to control exclusions.

---

--version — Version information

Shows CLI and template version information:

evermod --version

---

📁 Project Structure

EverMod projects include an evermod.manifest.json file used to track:

• Project type (mod or workspace)
• Minecraft versions
• Installed mods
• EverMod integration status

This allows EverMod to work reliably across updates.

---

🧠 Notes

• EverMod uses Git submodules to manage its framework
• Gradle wrapper files are generated automatically
• The CLI works interactively by default

---

👨‍💻 Author

WipoDev 🌐 https://www.wipodev.com 📦 GitHub

---

🪪 License

Licensed under the Apache License 2.0. You are free to use, modify, and distribute EverMod CLI with proper attribution.