No description
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Lars Oste 3071100bca docs: echte Umlaute im Kommentar-Beispiel
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-01 22:14:25 +02:00
README.md docs: echte Umlaute im Kommentar-Beispiel 2026-09-01 22:14:25 +02:00
sources.json schema: optionales warning-Feld + COI-Extended-Legal-Hinweis migriert 2026-08-17 22:57:18 +02:00

KroModIx.CoiModIndex

Kuratierte Liste von GitHub-Repos mit Captain of Industry-Mods.

Wird vom KroModIx-Plugin.CaptainOfIndustry beim Start heruntergeladen (6 h Cache) und im Workshop-Tab-Empty-State als klickbare Liste angezeigt. Der User klickt → Browser oeffnet den Repo.

Warum extern und nicht im Plugin gebundelt?

Damit jede laufende Installation sofort neue Sources sieht, sobald hier ein PR gemerged wird — kein Plugin-Rebuild + Update-Roundtrip noetig. Analog zum KroModIx.PluginIndex.

Wie einen neuen Mod-Repo vorschlagen

  1. Fork dieses Repo.

  2. Editiere sources.json und fuege einen Eintrag zum sources-Array hinzu:

    {
      "repo": "GitHubUser/RepoName",
      "displayName": "Human-friendly Name",
      "description": "1-2 Saetze was der Mod (oder das Bundle) macht.",
      "tags": ["framework", "example", "logistics", ...]
    }
    
  3. Setze updatedUtc auf das aktuelle UTC-Datum (date -u +"%Y-%m-%dT%H:%M:%SZ").

  4. PR gegen main.

Kriterien

  • Github-Repo — kein Discord-Link, kein Google-Drive.
  • Aktiv gewartet — letzter Commit < 12 Monate alt (oder klar „stable/archived" markiert).
  • CoI-spezifisch — keine generischen Unity-Mods.
  • Freie Lizenz — MIT / Apache / GPL / MPL o.ae. (im Repo sichtbar).

Schema

{
  "schema": 1,
  "updatedUtc": "2026-08-17T20:00:00Z",
  "sources": [
    {
      "repo": "owner/name",       // Pflicht — GitHub-Repo (kein voll-URL)
      "displayName": "Foo Mod",   // Pflicht — in der UI angezeigt
      "description": "...",       // Pflicht — 1-2 Saetze
      "warning": "...",           // optional — gelbes ⚠-Chip in der UI
                                  // (Legal-Konflikt, veraltet, EA-only,
                                  // Adult-Content etc.)
      "tags": ["framework"]       // optional — später für Filter
    }
  ]
}

Wann warning nutzen

Setze warning, wenn ein Repo Nutzer-Aufmerksamkeit vor dem Install verdient. Beispiele:

  • Rechtlich problematisch — z.B. Bundle das gegen die Modding-Exception des Entwicklers verstoesst.
  • Nicht mehr kompatibel — funktioniert nur mit einer alten Game-Version.
  • Early Access / Alpha — instabil, bricht Save-Games.
  • Adult / NSFW — Content der ohne Consent unerwuenscht ist.

Das Plugin rendert ein gelbes ⚠-Chip mit dem Warning-Text in der Sources-Card. Ohne warning bleibt die Card „neutral".

Lizenz

Die Liste selbst: MIT. Die referenzierten Repos haben ihre eigenen Lizenzen.