home products documents terms contact shop (coming soon!)

Installation Guide

Complete guide to install CobbleRanked on your Minecraft server.

Required Mods

Place all of these in your mods/ folder:

ModVersionDownload
Fabric Loader0.17.2+fabricmc.net
Fabric APILatestModrinth
Fabric Language Kotlin1.13.6+Modrinth
Cobblemon1.7.1+Modrinth
GashiLibs1.0.3+GashiStudios Discord
MailLib1.0.1+GashiStudios Discord
CobbleRanked2.0.4+GashiStudios Discord

Target: Minecraft 1.21.1 (Fabric server)

Optional Mods

These mods are NOT required but add extra features:

ModPurposeWhen to Install
LuckPermsPermissionsOnly if you want granular permission control
Text Placeholder APIPlaceholdersOnly if using with other mods that need placeholders

Minimal Setup Example

For a basic server, you only need:

mods/
├── fabric-api-x.x.x+1.21.1.jar
├── fabric-language-kotlin-x.x.x+kotlin.x.x.x.jar
├── Cobblemon-fabric-x.x.x+1.21.1.jar
├── gashilibs-1.0.3.jar
├── maillib-1.0.1.jar
└── CobbleRanked-2.0.4.jar

Installation Steps

1. Place Mods

Copy all JARs to server/mods/ folder

2. Start Server

On first launch, config files auto-generate:

server/
├── config/
│   └── cobbleranked/
│       ├── config.yaml         ← Main config
│       ├── arenas.yaml         ← Battle coordinates
│       ├── blacklist.yaml      ← Pokemon/move restrictions
│       ├── rewards.yaml        ← Season rewards
│       ├── data.db             ← SQLite database
│       ├── gui/                ← GUI layouts
│       └── language/           ← Language files

3. Verify Installation

Console output:

[CobbleRanked] Mod initialized successfully
[CobbleRanked] Configuration loaded
[CobbleRanked] Database initialized (SQLite)
[CobbleRanked] Season manager initialized

In-game test:

/ranked

If GUI opens → Installation successful!

Initial Setup (Optional)

Language Configuration

Default: English (en-us)

Edit config/cobbleranked/config.yaml:

# config.yaml
language: "ja-jp"  # en-us or ja-jp

Reload: /rankedadmin reload

Arena Setup (Recommended)

Teleport players to battle coordinates when battles start.

Step 1: Stand at the position where you want Player 1 to teleport

Step 2: Run command:

/rankedadmin setArena main_arena pos1

Step 3: Move to Player 2’s position and run:

/rankedadmin setArena main_arena pos2

Saved: Position (x, y, z), facing (yaw, pitch), dimension

Details: Arena Configuration

Basic Rules (Recommended)

Ban legendaries and OHKO moves.

See Blacklist Configuration for full setup.

Cross-Server Setup (Advanced)

Required for: Multi-server networks sharing rankings

Requirements:

  • MySQL 8.0+
  • Redis 6.0+
  • Velocity 3.4.0+

Full Guide: Cross-Server Setup

File Structure Reference

config/cobbleranked/
├── config.yaml            # Main settings (language, database, cross-server)
├── elo.yaml               # ELO/rating system settings
├── battle.yaml            # Battle formats, timers, sounds
├── matchmaking.yaml       # Queue matching rules
├── season.yaml            # Season schedule and reset behavior
├── arenas.yaml            # Battle coordinates
├── blacklist.yaml         # Restrictions (Pokemon/moves/abilities/items)
├── rewards.yaml           # Season-end rewards
├── data.db                # SQLite database (auto-created)
├── gui/
│   ├── ranked_gui.json5   # Ranked menu layout
│   ├── casual_gui.json5   # Casual menu layout
│   └── ...
└── language/
    ├── en-Us.json5        # English messages
    └── ja-Jp.json5        # Japanese messages

Next Steps

For Casual Servers

  1. Set arenas - Battle locations
  2. Configure rewards - Season prizes
  3. Customize GUI - Interface tweaks

For Competitive Servers

  1. Configure blacklist - Smogon/VGC rules
  2. Adjust ELO system - Fine-tune ratings
  3. Set battle settings - Turn timers, team selection

For Cross-Server Networks

  1. Complete cross-server setup - Full guide
  2. Configure database - MySQL setup

See Also