Skip to content

README.md

Latest commit

 

History

History
45 lines (30 loc) · 1.46 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.46 KB
Raw

⚔️ Catan Helper

A mobile-friendly companion tool for Settlers of Catan: Cities & Knights played on Colonist (g.csdu.co.uk).

🎮 What it does

  • 📦 Resources - See all your resources and commodities at a glance
  • 🏛️ Development Tracks - View your Trade, Science, and Politics levels
  • 🔨 Build Guide - Instantly see what you can afford to build
  • 📜 Card Info - Full descriptions of all progress cards you hold

📱 Works on Mobile!

The helper is designed to work on smartphones. It shows a full-screen overlay so you can check your status without squinting at the game.

🚀 How to Use

  1. Visit the helper page → [Your GitHub Pages URL]
  2. Install the bookmarklet (drag to bookmarks bar or copy the code)
  3. Open your Catan game at g.csdu.co.uk
  4. Click the bookmarklet to see your dashboard

Mobile Installation

iPhone/Safari:

  1. Copy the bookmarklet code
  2. Create any bookmark
  3. Edit the bookmark and paste the code as the URL

Android/Chrome:

  1. Copy the bookmarklet code
  2. Create/edit a bookmark and paste the code as the URL

🛠️ Technical Details

This is a client-side bookmarklet that:

  • Connects to the game's WebSocket server
  • Extracts your player's game state
  • Displays it in a friendly overlay

No server required - it's 100% client-side JavaScript.

⚠️ Disclaimer

This tool is for personal use only. Not affiliated with Catan GmbH or Colonist.io.