Skip to content

Free games for graphing calculators: NumWorks, TI-Nspire CX, Casio fx-CG50 and soon TI-84 Plus CE. Balatro, Celeste, Hollow Knight, Minecraft and more.

12.5 KB
Raw Blame
#!/usr/bin/env python3
"""Release notes and file labels for a GitHub release.

GitHub lists a release's files from A to Z and there is no way to reorder
them, so the notes carry the list in a useful order (NumPlay first, then its
discreet versions, then each game on its own in the launcher's order) with a
link to each file, and every file gets a label saying what it is.

- --notes FILE: writes the notes, .github/release.md (the introduction), what's new in
  this version (its section of CHANGELOG.md) and then the list;
- --title FILE: writes the release's title, "NumPlay v1.3.0: " and the heading of
  its section of CHANGELOG.md;
- prints one `path#label` per line, the arguments of `gh release create`.

Usage: release.py --tag v1.3.0 --notes build/data/release-notes.md --title build/data/release-title.txt
                  --build build/compiled
"""
import argparse
import json
import os
import re

ROOT = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")
REPO = "https://github.com/Mason363/NumPlay"
# in games.json, but not games
EXTRAS = set()
# games too big to fit next to NumPlay on the calculator: only on their own, in a section of their own
ALONE = {
    "celeste": ("Celeste", "the whole climb up Celeste Mountain"),
    "hollowknight": ("Hollow Knight", "from King's Pass to Hornet in Greenpath"),
    "hkfungal": ("Hollow Knight: Fungal Wastes", "Hallownest past Greenpath, sharing Hollow Knight's saves"),
    "undertale": ("Undertale", "the whole Underground, to the barrier and the neutral ending"),
    "deltarune": ("Deltarune", "Chapter 1, from Kris's room into the Dark World and its first battles"),
    "subway": ("Subway Surfers", "the endless run down the subway's tracks, in 3D"),
    "fnaf": ("Five Nights at Freddy's", "five nights at Freddy Fazbear's Pizza, the 6th and the Custom Night"),
    "hillclimb": ("Hill Climb Racing", "Newton Bill's ride up the hills: thirteen stages, thirteen vehicles"),
    "championisland": ("Champion Island", "the Doodle Champion Island Games"),
    "numpowder": ("NumPowder", "The Powder Toy on the calculator, with nearly 200 elements"),
    "finalearth2": ("The Final Earth 2", "build a city on floating islands in space"),
    "doom": ("Doom", "Knee-Deep in the Dead, all nine levels"),
    "isaac": ("The Binding of Isaac", "a whole run, from the Basement to Sheol and the Cathedral"),
    "pvz": ("Plants vs. Zombies", "the whole Adventure, from the front lawn to Dr. Zomboss"),
    "leveldevil": ("Level Devil", "Unept's troll platformer, all sixteen worlds"),
    "sonic": ("Sonic the Hedgehog", "the whole 1991 game, Green Hill to the Final Zone"),
    "numvisuals": ("NumVisuals", "moving backgrounds with a clock, a stopwatch, a timer, a counter or your own words"),
    "meowdoku": ("Meowdoku", "one cat per row, column and color, with the game's own puzzles, in its order"),
    "cookieclicker": ("Cookie Clicker", "the whole game, to the grandmapocalypse, ascension and the dragon"),
    "jetpackjoyride": ("Jetpack Joyride", "Barry's run through the lab, with five vehicles and the Final Spin"),
    "stickmanhook": ("Stickman Hook", "swing from hook to hook: 39 levels made by hand, then endless ones"),
    "donkeykong": ("Donkey Kong", "the 1981 arcade game: barrels, pies, elevators and rivets, up to Pauline"),
    "dune": ("Dune", "roll down the dunes and fly over the line, with the shop's 26 balls and 7 landscapes"),
    "monkeymart": ("Monkey Mart", "run a grocery mart as a monkey, both marts: crops, animals, machines and workers"),
    "tombofthemask": ("Tomb of the Mask", "dash through the tomb: the endless arcade climb and all 200 stages, with the 16 masks"),
    "uno": ("UNO", "the card game against one to three bots, with the official rules and scoring to 500"),
    "fnf": ("Friday Night Funkin'", "the Tutorial, Weeks 1 to 7, Weekend 1 and LE SSERAFIM, in story mode and freeplay"),
    "angrybirds": ("Angry Birds", "the 429 levels of the Chrome edition, its seven birds and the Mighty Eagle"),
    "polytrack": ("PolyTrack", "Kodub's low-poly time trial racer: its 17 tracks, loops, wall rides and jumps, against your ghost"),
    "paperclips": ("Universal Paperclips", "Frank Lantz's game of an AI making paperclips: business, the Earth, then the universe"),
    "badtime": ("Bad Time Simulator", "the Sans fight: 24 attacks of bones, Gaster Blasters and the blue heart, after jcw87's Bad Time Simulator"),
    "mahjong": ("Mahjong", "Mahjong solitaire: 144 tiles in the Turtle, the Dragon, the Crab and the Spider, every deal winnable"),
    "rider": ("Rider", "Ketchapp's neon motorbike game: the endless run, 48 levels and 55 bikes, one button to ride and flip"),
    "snowrider": ("Snow Rider 3D", "the endless sled run: its slope, sleds, gifts and crashes, read from the game's own Unity project"),
    "templerun": ("Temple Run", "the endless run from the temple: turn, jump, slide and lean, with the game's rules and numbers"),
    "fnaf2": ("Five Nights at Freddy's 2", "the new pizzeria's six nights and the Custom Night: the mask, the music box, the flashlight"),
    "fnaf3": ("Five Nights at Freddy's 3", "Fazbear's Fright's six nights with Springtrap and the phantoms: the lure, the vents, the maintenance panel"),
    "fnaf4": ("Five Nights at Freddy's 4", "the bedroom's nights with the Nightmares: listen at the doors, the closet, the bed, Fun with Plushtrap"),
    "fnafworld": ("FNAF World", "the RPG: the overworld, battles with a party of eight, 48 characters, chips, bytes, bosses and endings (6 MB apps only)"),
    "famidash": ("Famidash", "TFDSoft's Geometry Dash for the NES, made for the calculator: the 173 levels of Famidash HUGE, every mode, practice mode"),
    "clashroyale": ("Clash Royale", "battles against a bot: 41 cards of the 2016 game, its seven arenas, elixir, crowns and trophies"),
    "catninja": ("Cat Ninja", "Richman Stewart's Flash platformer: its 30 levels of wall jumps and traps, the boss and the crystals"),
    "kingdomrush": ("Kingdom Rush", "Ironhide's 2011 tower defense: its 12 stages with Heroic and Iron challenges, every tower, spell and boss, the seven heroes"),
    "mrbullet": ("Mr Bullet", "Lion Studios' spy puzzles: 596 levels of Classic, Grenades, Hostages and Friendly Fire, read from the game's own files"),
    "motox3m": ("Moto X3M", "Madpuffers' stunt bike racing: all 50 levels, the flips, the stars and the six bikes, on the game's own physics"),
    "amongus": ("Among Us", "Innersloth's game on the Skeld against up to 9 bots: every task, sabotages, vents, kills, meetings and votes"),
    "imposter": ("Imposter", "the party game: pass the calculator, everyone sees the secret word but the imposter, 30 categories"),
    "fourplayer": ("2 3 4 Players", "one-key party games for 2, 3 or 4 players on one calculator, and teams: 14 minigames"),
    "circloo": ("circloO", "Florian van Strien's physics game: its 14 levels and 6 hard mode levels, read from the game's own files"),
    "numpico": ("NumPico", "PICO-8 carts on the calculator: add your own .p8 and .p8.png carts in NumPlay Studio"),
}
VARIANTS = [
    ("NumPlay-Invisible.nwa", "The same app, hidden: a blank icon with no name"),
    ("NumPlay-Matrices.nwa", "The same app, disguised as a math app called Matrices"),
]
# other languages, and Upsilon (see the README)
LANGUAGES = [
    ("NumPlay-French.nwa", "NumPlay en français : tous les jeux, en français"),
    ("NumPlay-Chinese.nwa", "NumPlay 中文版:所有游戏,简体中文"),
]
# big games in another language (in build/compiled/games)
ALONE_LANGUAGES = [("UniversalPaperclips-French.nwa", "Universal Paperclips en français")]
UPSILON = ("NumPlay-Upsilon.nwa", "For calculators running Upsilon (N0110, N0115): the 24 games that fit in the memory "
           "Upsilon gives apps. Install it with nwlink, see the README")


def standalone_names():
    """Game id -> its own .nwa, from the Makefile (APP_<id> = path:Name.nwa)."""
    names = {}
    for line in open(os.path.join(ROOT, "Makefile")):
        m = re.match(r"APP_(\w+)\s*=\s*\S+:(\S+\.nwa)\s*$", line)
        if m:
            names[m.group(1)] = m.group(2)
    return names


def changes(version):
    """(the heading, the lines) of this version's section of CHANGELOG.md: "## 1.3.0: heading" and what's under it"""
    path = os.path.join(ROOT, "CHANGELOG.md")
    if not os.path.exists(path):
        return None, []
    heading, lines = None, []
    for line in open(path).read().splitlines():
        if line.startswith("## "):
            if heading is not None:
                break
            v, _, rest = line[3:].partition(":")
            if v.strip() == version:
                heading = rest.strip()
        elif heading is not None:
            lines.append(line)
    while lines and not lines[-1].strip():
        lines.pop()
    while lines and not lines[0].strip():
        lines.pop(0)
    return heading, lines


def main():
    ap = argparse.ArgumentParser()
    ap.add_argument("--tag", required=True)
    ap.add_argument("--notes", required=True)
    ap.add_argument("--title", help="where to write the release's title")
    ap.add_argument("--build", default="build/compiled")
    a = ap.parse_args()
    # (a game the default NumPlay.nwa leaves out, "default": false, comes from the customizer website)
    games = [g for g in json.load(open(os.path.join(ROOT, "games", "games.json"))) if g.get("default", True)]
    apps = standalone_names()
    count = sum(1 for g in games if g["id"] not in EXTRAS)
    extras = " and ".join(g["title"] for g in games if g["id"] in EXTRAS)
    everything = f"All {count} games" + (f" and {extras}" if extras else "") + " in one app"

    def link(name):
        return f"[{name}]({REPO}/releases/download/{a.tag}/{name})"

    files = [(os.path.join(a.build, "NumPlay.nwa"), f"NumPlay.nwa · Start here: {everything[0].lower() + everything[1:]}")]
    notes = ["### Start here", "", "| File | |", "| --- | --- |",
             f"| **{link('NumPlay.nwa')}** | **{everything}.** Start here! |", "",
             "### The same app, in disguise", "", "| File | |", "| --- | --- |"]
    for name, what in VARIANTS:
        files.append((os.path.join(a.build, name), f"{name} · {what}"))
        notes.append(f"| {link(name)} | {what} |")
    notes += ["", "### In French and Chinese", "", "| File | |", "| --- | --- |"]
    for name, what in LANGUAGES:
        files.append((os.path.join(a.build, name), f"{name} · {what}"))
        notes.append(f"| {link(name)} | {what} |")
    for name, what in ALONE_LANGUAGES:
        files.append((os.path.join(a.build, "games", name), f"{name} · {what}"))
        notes.append(f"| {link(name)} | {what} |")
    # the games too big to share the calculator with NumPlay, each its own app
    alone = [gid for gid in ALONE if gid in apps]
    if alone:
        notes += ["", "### Individual Games", "", "| File | |", "| --- | --- |"]
        for gid in alone:
            title, what = ALONE[gid]
            name, what = apps[gid], f"{title}: {what}"
            files.append((os.path.join(a.build, "games", name), f"{name} · {what}"))
            notes.append(f"| {link(name)} | {what} |")
    name, what = UPSILON
    notes += ["", "### On Upsilon", "", "| File | |", "| --- | --- |", f"| {link(name)} | {what} |"]
    files.append((os.path.join(a.build, name), f"{name} · {what}"))
    notes += ["", "### Each one on its own", "", "In the launcher's order.", "", "| File | |", "| --- | --- |"]

    for g in games:
        name = g.get("app") or apps.get(g["id"])
        if not name:
            continue
        tagline = g["tagline"][0].lower() + g["tagline"][1:]
        what = f"Only {g['title']}: {tagline}"
        files.append((os.path.join(a.build, "games", name), f"{name} · {what}"))
        notes.append(f"| {link(name)} | {what} |")
    notes += ["", "<sub>The file list below is sorted A to Z by GitHub. Each file's label says what it is.</sub>"]

    intro = open(os.path.join(ROOT, ".github", "release.md")).read().rstrip()
    heading, new = changes(a.tag.lstrip("v"))
    if new:
        intro += "\n\n### What's new\n\n" + "\n".join(new)
    with open(a.notes, "w") as f:
        f.write(intro + "\n\n" + "\n".join(notes) + "\n")
    if a.title:
        with open(a.title, "w") as f:
            f.write(f"NumPlay {a.tag}" + (f": {heading}" if heading else "") + "\n")
    for path, label in files:
        if not os.path.exists(path):
            raise SystemExit(f"release: missing {path}")
        if len(label) > 255:  # (GitHub refuses longer labels, and the release with them)
            raise SystemExit(f"release: {os.path.basename(path)}'s label is {len(label)} characters, 255 at most")
        print(f"{path}#{label}")


if __name__ == "__main__":
    main()