Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# server pack builder

A Python CLI tool for filtering Minecraft modpacks to create server-compatible mod sets. It supports both local directory processing and direct Modrinth modpack integration.
A Python CLI tool for filtering Minecraft modpacks to create server-compatible mod sets. It supports local directory processing, Modrinth modpack integration, and CurseForge modpack integration.

## Installation

Expand All @@ -10,9 +10,21 @@ Ensure Python 3.8+ is installed. Install dependencies:
pip install -r requirements.txt
```

### CurseForge API Key

To use CurseForge features, you need to obtain an API key:

1. Visit [CurseForge for Studios](https://console.curseforge.com/)
2. Sign in or create an account
3. Navigate to "API Keys" and generate a new key
4. Set the environment variable:
```bash
export CURSEFORGE_API_KEY=your_api_key_here
```

## Usage

The tool operates in two modes: Local and Modrinth.
The tool operates in three modes: Local, Modrinth, and CurseForge.

### Local Mode
Process a local directory of mods:
Expand All @@ -32,6 +44,17 @@ python server_pack_builder.py --modrinth-url https://modrinth.com/modpack/fabric
python server_pack_builder.py --modrinth-url fabric-boosted --pack-version "1.2.3"
```

### CurseForge Mode
Download and filter a CurseForge modpack by ID:

```bash
# Download latest file
python server_pack_builder.py --curseforge-id 123456

# Download specific file
python server_pack_builder.py --curseforge-id 123456 --file-id 789012
```

### GUI Mode
Launch the graphical user interface for an easy-to-use experience:

Expand All @@ -44,6 +67,7 @@ python server_pack_builder.py --gui
#### Common
- `--dry-run`: Simulate the process without copying or writing files.
- `--verbose`, `-v`: Enable verbose logging.
- `--gui`: Launch the graphical user interface.

#### Local Mode
- `--source`, `-s`: Path to the source 'mods' directory.
Expand All @@ -54,12 +78,18 @@ python server_pack_builder.py --gui
- `--pack-version`: Specific version ID or Number to download (overrides latest).
- `--output-file`, `-o`: Output path for the generated `.mrpack` (optional, defaults to `{PackName}-server.mrpack`).

#### CurseForge Mode
- `--curseforge-id`, `-c`: CurseForge Modpack ID (required for CurseForge mode).
- `--file-id`: Specific file ID to download (optional, defaults to latest).
- `--output-file`, `-o`: Output path for the generated `.zip` (optional, defaults to `{PackName}-server.zip`).

## Features

- **Client-Side Filtering**: Automatically detects and removes client-only mods by inspecting JAR metadata.
- **Modrinth Integration**: Downloads, filters, and repacks `.mrpack` files.
- **Modrinth Search**: Search for modpacks and view their details/logos within the GUI.
- **Version Selection**: Choose between the latest release or specific versions of a modpack.
- **CurseForge Integration**: Downloads, filters, and repacks CurseForge modpacks (`.zip` format).
- **Modpack Search**: Search for modpacks from both Modrinth and CurseForge within the GUI.
- **Version Selection**: Choose between the latest release or specific versions/files of a modpack.
- **Multi-Loader Support**: Works with Fabric and Forge mod loaders.
- **Overrides Preservation**: Keeps configuration and other data from the modpack's `overrides` folder.

Expand All @@ -69,7 +99,7 @@ python server_pack_builder.py --gui
<div>
<img src="screenshots/main_window.png" alt="Main Application Window" height="200">
<p><strong>Main Application Window</strong></p>
<p>The main interface allowing selection between Local and Modrinth modes.</p>
<p>The main interface allowing selection between Local, Modrinth, and CurseForge modes.</p>
</div>
<div>
<img src="screenshots/search_dialog.png" alt="Modrinth Search Dialog" height="200">
Expand Down
Loading