Skip to content

xkoranate-CE 0.4.0

Choose a tag to compare

@github-actions github-actions released this 18 Aug 20:40
· 179 commits to main since this release
2e96d68

OOC

xkoranate-CE is finally out of pre-release. Three release candidates' worth of community testing later, this is the first stable build of the Python port, and it has already gone past where the original C++ program left off. -Mertagne
If you would like to buy me a beer as thanks, you can do so here.

To download the program, scroll down to the Assets section at the bottom of this page and download the correct file for your operating system.

Downloads

These builds are unsigned/unnotarised, so your OS may warn on first launch (macOS Gatekeeper, Windows SmartScreen) - you'll need to explicitly allow the app to run.

  • macOS (Apple Silicon): xkoranate-0.4.0-macos-arm64.zip → unzip, then run xkoranate.app.
  • macOS (Intel): xkoranate-0.4.0-macos-x86_64.zip → unzip, then run xkoranate.app.
  • Windows: xkoranate-0.4.0-windows.zip → unzip, then run xkoranate\xkoranate.exe.
  • Linux: xkoranate-0.4.0-linux.tar.gz → extract, then run xkoranate/xkoranate.

xkoranate-CE 0.4.0

The first stable release of xkoranate-ce-python - a faithful Python/PySide6 port of xkoranate-CE, the sports "scorinator" used by NS Sports, the sports roleplay forum for NationStates. Originally written in Qt4/C++ by Commerce Heights, this port preserves the original program's behaviour - scorination maths, competition formats, file formats, and general UI - while running on current macOS, Windows, and Linux via Python and Qt 6.

This release consolidates everything from 0.4.0-pr1, -pr2 and -pr3, plus the LISA and table-generator work that landed afterwards. If you have been running a pre-release, this is a straight upgrade! Your events, tables, signup lists and settings all carry over.

Licensed under GPLv3, with full attribution to the original xkoranate-CE authors and contributors: see NOTICE.md.


The port itself

  • Cross-platform builds - native builds for macOS (Apple Silicon and Intel), Windows, and Linux, produced by the same PyInstaller spec and built automatically on release. (#18, #38)
  • Test suite + CI - unit and integration tests run on every push, and build jobs verify the frozen app on all target platforms, so community changes are known to work before they reach main. Coverage now includes the paradigm classes themselves, where the scorination math actually lives. (#16, #46)
  • Reproducible dev environment - contributor setup is managed with pixi, which resolves PySide6 and Qt as matched, locked binaries. This removes a class of bug where a machine's Python Qt bindings and native Qt libraries drift out of sync. (#46)
  • Crash/launch logging - the app writes a log file on any failure, including ones that happen before it can finish starting, and shows an error dialog for crashes once it's running. See the getting started guide for log locations. (#36)

Scorination and paradigms

  • Home advantage is user-adjustable - magnitude, not just on/off, across NSFS, SQIS, Footba11er and Howzzat, with the underlying NSFS math corrected to match the original formula. This fixes the long-standing "home advantage bug". (#9, #11, #14, #15)
  • LISA paradigm ported and then brought fully up to par with SQIS/NSFS (#1, #17, #42):
    • Extra-time formula corrected to the reference algorithm's smooth probability floor instead of an approximated hard cutoff.
    • Style-modifier curve replaced with the same 5-point distribution SQIS/NSFS use for association football.
    • Per-event home advantage override, and a working schedule button.
  • Three LISA home advantage modes (#45) - pick one per event:
    • Fixed (default) - one flat magnitude for every match, same as every other paradigm.
    • Adversarial (per-team) - each team sets its own −5 to +5 rating, and the two teams' ratings combine. Boosting your own home ground also raises the boost you hand opponents when you visit them, so it's self-limiting by design; nobody can max out the slider for free. That makes it the right fit for player-vs-player competition, and it's the behaviour the algorithm's own creator built to avoid a home-advantage arms race there.
    • Individual (per-team, uncapped) - each team's own rating applies only when they are at home, with no effect on or from the away side, and no cap. Not self-limiting, so it suits domestic leagues where home advantage needn't be zero-sum and can be as wacky as an organiser likes.
    • Both per-team modes add a "Home Adv" participant column, and both reproduce the flat default exactly when left untouched.
  • Formula constants are now adjustable per event - LISA's power scalar, reference rank, REAR and margin divisor; SQIS's constants A/B and attack count; NSFS's full rank and attack coefficient set. Previously XML-only. Everything beyond home advantage and "Show team names" sits behind a collapsed "Advanced options" section, each field with a restore-default button. (#42)
  • Skill-normalization fields now match the maths - minimum/maximum skill bounds are hidden for the paradigms whose formulas provably ignore them (SQIS/Footba11er/Howzzat win probability is a plain skill ratio; LISA needs true raw rank), so the only knobs shown are the ones that actually change results. Also adds a "Pin to max participant rank" option that follows the highest entered rank instead of acting as a ceiling that clamps entries. (#42)
  • Odds calculator and automatic schedule output for head-to-head match paradigms. LISA's odds are now computed exactly from the algorithm rather than sampled, since its win/draw/loss split is fully determined. (#12, #13, #45)

Table generator

  • OT/shootout tracking and NHL-style points - standings now track regulation vs. overtime/shootout results, with configurable OT/SO win and loss points on top of win/draw/loss, so leagues can score NHL-style (2-2-2-1-1-0) rather than a flat split. Matches are tagged either by a trailing OT/SO marker in the results box (Aquilla 3–2 OT Busby) or automatically when a round-robin's own simulation resolves a tie. (#43)
  • Recognises the simulator's own output format when pasted back in - Aquilla 2–2 Busby (3–2 OT), including two-stage tiebreakers like (2–2 AET) (3–4 pen.). Only real tiebreaker keywords count, so teams named Ottawa or Southampton, and bracketed suffixes like Busby (2–1 Reserve), are left alone. (#43)
  • Six new standings tiebreakers - regulation wins, overtime/shootout wins, losses, home losses, away wins, home goals conceded, plus a last-resort coin flip that is persisted per team in the table file, so reopening or regenerating the table never re-rolls it. (#43)
  • "OT/SO breakdown" column toggle (OTW/SOW/OTL/SOL). (#43)

Interface

  • Modernized UI - Material Design icons, a discoverable File/View menu bar, and general UX polish (dialog button colours, dropdown scaling, participant wording). (#2, #10)
  • Three themes - Light, Dark, and True Dark (OLED), which forces the background to pure black. Theme selection lives in the View menu. (#34)
  • BBCode output - scorinated results can be wrapped in [pre] tags for direct posting to the forum, with match winners automatically bolded in head-to-head result lines. (#7, #19)

Fixes

  • Windows file dialogs - "Open"/"Save" for events, tables, results and signup lists popped a "you can't open this location using this program" error instead of a file picker; Qt's internal search-path aliases (events:/) were reaching the native Windows dialog as literal paths and being read as a URL scheme. Each alias is now resolved to a real directory first. (#39, fixes #37)
  • Intel Macs - macOS releases were arm64-only, with no Rosetta path for an arm64 binary. Separate Apple Silicon and Intel builds now ship. (#38)
  • Linux launch failures - two separate bugs made every shipped Linux binary fail instantly with no visible error: CI bundled only enough shared libraries to run on the build machine itself, and the build machine's glibc was newer than several supported distros. The build now bundles the full dependency closure, targets an older Ubuntu LTS baseline, and is verified by launching in a bare container. (#33, #36)
  • Single-click selection in reorderable lists (tiebreaker order, sort criteria) needed a second click, because the edit trigger made Qt wait out the double-click interval first. Single click highlights immediately; double-click still edits. The sort-criteria highlight also picks up the theme accent colour. (#41)
  • Numeric athlete-list columns (rank, seed) sort numerically instead of alphabetically. (#6)
  • CSV/TXT athlete import no longer drops style mods and other extra columns, so they can be imported. (#8)
  • "Maximum skill" default was silently clamped to 99.99 on every event ever created, because the default value was applied before the spinbox range. (#42)
  • "Goals are called" dropdown no longer clips its widest item, and no longer clips its text against the dropdown arrow. (#43)
  • Long tooltips now wrap at a readable width instead of stretching to nearly the full screen. (#45)
  • Fixed a zero-division risk in pinned max-rank handling and an enabled-state bug in the advanced options section. (#42)

Compatibility

  • Scorination files (events/RPer lists/signups) and table generator files written by the original xkoranate-CE load unchanged, and files written by this port match the original format.
  • Table generator changes are purely additive: tables that never use an OT/SO decider compute points and sort exactly as before, and older table .xml files load with the existing win/loss configuration.
  • LISA events default to Fixed home advantage mode, which behaves exactly as the fixed magnitude always has, so existing events are unaffected.
  • Settings are stored under the same thirdgeek.com/xkoranate identifier, so directory preferences from an existing installation carry over.

Bug reports and feature requests go on the issues board.