> For the complete documentation index, see [llms.txt](https://our-story-network.gitbook.io/cr-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://our-story-network.gitbook.io/cr-wiki/cr-en/information/installation.md).

# Installation

## 📦 Installation Guide

{% hint style="info" %}

<p align="center"><strong>This guide</strong> will help you install the modpack, keep it up to date, and host a multiplayer server under the best conditions.</p>
{% endhint %}

***

## 🎮 Modpack Installation

{% tabs %}
{% tab title="Windows" %}

### 🖥️ Playing Solo

{% stepper %}
{% step %}
:inbox\_tray: Install the [CurseForge App](https://www.curseforge.com/download/app#download-options)
{% endstep %}

{% step %}
:mag\_right: Search for [Cobblemon Realms](https://www.curseforge.com/minecraft/modpacks/cobblemon-realms)
{% endstep %}

{% step %}
:package: Click `Install`
{% endstep %}

{% step %}
:hourglass\_flowing\_sand: Wait while the mods are downloaded and installed
{% endstep %}

{% step %}
:rocket: Launch the modpack and start your adventure!
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="MacOS" %}

### 🖥️ Playing Solo

{% stepper %}
{% step %}
:inbox\_tray: Install the [CurseForge App](https://www.curseforge.com/download/app#download-options)
{% endstep %}

{% step %}
:mag\_right: Search for [Cobblemon Realms](https://www.curseforge.com/minecraft/modpacks/cobblemon-realms)
{% endstep %}

{% step %}
:package: Click `Install`
{% endstep %}

{% step %}
:apple: If necessary, allow CurseForge through macOS security settings
{% endstep %}

{% step %}
:hourglass\_flowing\_sand: Wait while the mods are downloaded and installed
{% endstep %}

{% step %}
:rocket: Launch the modpack and start your adventure!
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linux" %}

### 🖥️ Playing Solo

{% stepper %}
{% step %}
:inbox\_tray: Install the [CurseForge App](https://www.curseforge.com/download/app#download-options)
{% endstep %}

{% step %}
:mag\_right: Search for [Cobblemon Realms](https://www.curseforge.com/minecraft/modpacks/cobblemon-realms)
{% endstep %}

{% step %}
:package: Click `Install`
{% endstep %}

{% step %}
:coffee: Make sure Java 21 is installed on your system
{% endstep %}

{% step %}
:hourglass\_flowing\_sand: Wait while the mods are downloaded and installed
{% endstep %}

{% step %}
:rocket: Launch the modpack and start your adventure!
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

{% hint style="success" %}
For the best possible experience, we recommend using CurseForge. The launcher automatically handles dependencies, configurations, and modpack updates.
{% endhint %}

{% tabs %}
{% tab title="Windows" %}

## ⚙️ Recommended Configuration

{% stepper %}
{% step %}
☕ Make sure [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-windows) is installed on your computer.
{% endstep %}

{% step %}
💾 Allocate **8 GB of RAM** to the modpack in the CurseForge settings.

```
-Xms8G
-Xmx8G
```

{% endstep %}

{% step %}
🎮 Update your graphics card drivers (NVIDIA, AMD, or Intel).
{% endstep %}

{% step %}
🚀 Install the modpack on an **SSD** whenever possible to reduce loading times.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="MacOS" %}

## ⚙️ Recommended Configuration

{% stepper %}
{% step %}
☕ Make sure [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-mac) is installed on your Mac.
{% endstep %}

{% step %}
💾 Allocate **8 GB of RAM** to the modpack.

```
-Xms8G
-Xmx8G
```

{% endstep %}

{% step %}
🍎 Keep macOS up to date to benefit from the latest graphics optimizations.
{% endstep %}

{% step %}
🚀 Prefer using an **SSD** for better performance.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linux" %}

## ⚙️ Recommended Configuration

{% stepper %}
{% step %}
☕ Make sure you are using [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-linux) on your distribution.
{% endstep %}

{% step %}
💾 Allocate **8 GB of RAM** to the modpack.

```
-Xms8G
-Xmx8G
```

{% endstep %}

{% step %}
🎮 Ensure your graphics drivers (Mesa, NVIDIA, or AMD) are up to date.
{% endstep %}

{% step %}
🚀 Install the modpack on an **SSD** for faster loading times.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

{% hint style="warning" %}
:warning: Before opening a ticket on [Discord](https://discord.gg/kb8NSTF45n), make sure you have followed this guide completely and verified that your installation is working correctly. Many issues can be resolved by checking your Java version, allocated RAM, or reinstalling the modpack.
{% endhint %}

***

## 🔄 Updating the Client

When a new version of Cobblemon Realms is released, follow these steps to stay up to date.

### 🧭 Using CurseForge

1. Open the **CurseForge App** and go to **`My Modpacks`**.
2. Hover over *Cobblemon Realms* and click the **arrow** next to **`Play`**.
3. If an update is available, you will see **`Update Available`**.
4. Select the **latest version** and click **`Continue`**.
5. Wait for the installation to finish, then click **`Play`**.

🟢 **Tip:** CurseForge automatically applies configurations and dependencies. It is the **recommended launcher**.

### 🌍 Using Other Launchers (Prism, Modrinth, MultiMC)

If you use another launcher:

1. In CurseForge, click the `...` next to the modpack → **`Export Profile`**.
2. Import the exported `.zip` file into the launcher of your choice.
3. Some launchers may not apply all configurations correctly; **CurseForge remains the recommended option** for the best experience.

***

## 🎮 Hosting a Multiplayer Server

{% tabs %}
{% tab title="Windows" %}
{% stepper %}
{% step %}
☕ Install [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-windows)
{% endstep %}

{% step %}
💾 Allocate at least **8 GB of RAM dedicated to the server**
{% endstep %}

{% step %}
🌐 Make sure you have a stable internet connection
{% endstep %}

{% step %}
🛠️ You must be able to run `.bat` files

Port forwarding may be required to allow external players to join your server.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="MacOS" %}
{% stepper %}
{% step %}
☕ Install [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-mac)
{% endstep %}

{% step %}
💾 Allocate at least **8 GB of RAM dedicated to the server**
{% endstep %}

{% step %}
🌐 Make sure you have a stable internet connection
{% endstep %}

{% step %}
🛠️ You must be able to run `.sh` scripts

Depending on your network configuration, port forwarding may be required.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linux" %}
{% stepper %}
{% step %}
☕ Install [**Java 21**](https://www.oracle.com/java/technologies/downloads/#jdk21-linux)
{% endstep %}

{% step %}
💾 Allocate at least **8 GB of RAM dedicated to the server**
{% endstep %}

{% step %}
🌐 Make sure you have a stable internet connection
{% endstep %}

{% step %}
🛠️ You must be able to run `.sh` scripts

Basic Linux terminal knowledge is recommended.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

***

## 🛠️ Manual Server Installation

{% hint style="info" %}
💡 Don't want to handle the installation manually or configure port forwarding?

Use our official partner: [**BisectHosting**](https://bisecthosting.com/OurStory)
{% endhint %}

{% tabs %}
{% tab title="Windows" %}
{% stepper %}
{% step %}
📦 Download the Cobblemon Realms Server Pack
{% endstep %}

{% step %}
📂 Extract the archive into an empty folder
{% endstep %}

{% step %}
🖱️ Double-click the `run.bat` file
{% endstep %}

{% step %}
📜 Open the `eula.txt` file and change:

```
eula=false
```

to:

```
eula=true
```

{% endstep %}

{% step %}
🚀 Run `run.bat` again, then configure `server.properties` according to your needs
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="MacOS" %}
{% stepper %}
{% step %}
📦 Download the Cobblemon Realms Server Pack
{% endstep %}

{% step %}
📂 Extract the archive into an empty folder
{% endstep %}

{% step %}
🖥️ Open a terminal in the server folder and run:

```
./run.sh
```

{% endstep %}

{% step %}
📜 Open the `eula.txt` file and change:

```
eula=false
```

to:

```
eula=true
```

{% endstep %}

{% step %}
🚀 Run `run.sh` again, then configure `server.properties` according to your needs
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linux" %}
{% stepper %}
{% step %}
📦 Download the Cobblemon Realms Server Pack
{% endstep %}

{% step %}
📂 Extract the archive into an empty folder
{% endstep %}

{% step %}
🖥️ Make the script executable, then run it:

```
chmod +x run.sh
./run.sh
```

{% endstep %}

{% step %}
📜 Open the `eula.txt` file and change:

```
eula=false
```

to:

```
eula=true
```

{% endstep %}

{% step %}
🚀 Run `run.sh` again, then configure `server.properties` according to your needs
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

***

{% hint style="success" %}

### ☁️ Recommended Hosting: BisectHosting

Cobblemon Realms is partnered with **BisectHosting**, allowing you to install the modpack in just a few clicks without complex setup.

**Why choose BisectHosting?**

* 🚀 One-click modpack installation
* 💾 Automatic backups
* 🔄 Simplified updates
* 🛡️ DDoS protection included
* 🌍 Servers available in multiple regions worldwide
* ⚡ SSD storage and optimized performance
* 🧩 Full CurseForge compatibility

This lets you focus on your adventure rather than server administration.
{% endhint %}

{% hint style="info" %}

### 🎉 Partner Discount

🎁 By using the code `OurStory` when placing your order, you receive **25% off your first month of hosting**. A great way to launch your [Cobblemon Realms](https://www.curseforge.com/minecraft/modpacks/cobblemon-realms) server at a lower cost while supporting the development of the project.
{% endhint %}

***

## 📦 Manual Server Installation or Update

{% hint style="warning" %}
⚠️ Always create a full backup of your server before performing any installation or update.
{% endhint %}

{% tabs %}
{% tab title="Installation" %}
{% stepper %}
{% step %}
📥 Download the latest **Server Pack** from the **Files** section.
{% endstep %}

{% step %}
📂 Extract the archive into an empty folder or directly onto your server.
{% endstep %}

{% step %}
📋 Copy the following folders:

* `mods/`
* `config/`
* `kubejs/`
* `defaultconfigs/`
  {% endstep %}

{% step %}
🚀 Start the server and verify that it launches without errors.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Update" %}
{% stepper %}
{% step %}
📥 Download the latest **Server Pack**.
{% endstep %}

{% step %}
🛑 Completely stop your server.
{% endstep %}

{% step %}
🗑️ Delete the old folders:

* `mods/`
* `config/`
* `kubejs/`
* `defaultconfigs/`
  {% endstep %}

{% step %}
📂 Replace them with the folders from the new archive.
{% endstep %}

{% step %}
🚀 Restart the server.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

{% hint style="danger" %}

### ⚠️ Files You Should Never Delete

The following items are essential for your server to function properly:

* 🌍 `world/` → contains your world and all game data
* 📚 `libraries/` → contains the libraries required to launch the server
* ⚙️ `.jar` files → required for the server to start

Deleting any of these items may result in world loss or prevent the server from starting entirely.
{% endhint %}

***

{% hint style="success" %}

## 💡 Best Practices

* 💾 Always keep a recent backup of your world.
* 🔄 Make sure the server and all players are using the same modpack version.
* 🛠️ If you encounter issues, delete `config/` and `defaultconfigs/` then restart the game.
* ❓ Check our [FAQ](/cr-wiki/cr-en/information/faq.md) for common questions.
* 💬 Need help? Join our [Discord](https://discord.gg/kb8NSTF45n) server.
  {% endhint %}

***

{% hint style="success" %}

## Contact Us

<p align="center">If you have any questions, suggestions, or changes to propose, feel free to join us on <a href="https://discord.gg/kb8NSTF45n">Discord</a> and contact <strong>@FabLeKebab</strong> directly on the server for anything related to the wiki, or <strong>@Levels</strong> for anything related to the modpack.</p>
{% endhint %}

🔥 Enjoy your Pokémon adventures with friends or on your own; the Realms await you! 🧭✨


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://our-story-network.gitbook.io/cr-wiki/cr-en/information/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
