Texas Hold'em 1.0.1 — an iPod game, recompiled
=========================================

This is the game from an iPod, translated to run on this machine. It is the program only.

WHAT YOU HAVE TO SUPPLY
-----------------------

The game's own files: the folder named

    33333

as it sits on your iPod, under iPod_Control/Games (the games live inside the .bin next to it on
some models; whichever way you get at it, the folder is the thing). Nothing in this download is
the game itself, and nothing here will work without that folder. It is not included because it
is not ours to include: it is the game you bought, and yours to copy off your own device.

INSTALLING
----------

1. Put "holdem" wherever you like and make sure it is executable (chmod +x holdem).
2. Install SDL3 and zlib from your distribution if you haven't: they are not in here, because a
   Linux program takes its libraries from the machine it runs on. On Fedora that is
   `sudo dnf install SDL3 zlib-ng-compat`; on Debian and Ubuntu, `sudo apt install libsdl3-0 zlib1g`.
3. Run it. The first launch asks for the 33333 folder (or a zip of it) with the ordinary file
   browser, checks every file in it against the sizes and checksums the game shipped with, and
   copies it to

       $XDG_DATA_HOME/ipod-holdem/33333, or ~/.local/share/ipod-holdem/33333

   from where it is read every time after. Your saves go beside it.

This build was compiled against glibc 2.38 and needs that version or newer —
`ldd --version` says what you have. If yours is older, build from source; it is a plain
`cmake -B build && cmake --build build`, and the source release has the instructions.

There is no settings window on Linux — that one is a Cocoa window on macOS and a Win32 one on
Windows, and nobody has written a third — so the frame rate, the picture scaling and the key
bindings come from the settings file and the defaults. The game's own Options and Cheats screens
work as they do everywhere. There is no background music either; the sound effects are all here.

CONTROLS
--------

The iPod's click wheel and its five buttons, on whatever this machine has. Every one of them can
be rebound; the settings window (Ctrl+, on Windows, ⌘, on macOS) lists them, and the console
build has a controls screen of its own. See the project's README for the defaults.

WHAT ELSE IS IN HERE
--------------------

  COPYING.txt        the GNU General Public License, version 3, which this program is under.
  SDL3-LICENSE.txt   SDL3's licence. The program uses SDL for its window, input and sound, and
                     that licence asks to travel with it.

LICENCE
-------

This port is free software under the GNU General Public License, version 3 or later, whose full
text is in COPYING.txt beside this file. You may use it, study it, change it and pass it on, and
anyone you pass a changed version to is owed its source.

The source is published with this release, as the `-source.tar.gz` file released alongside it.
Note that five of the six titles need one more step before they build: the machine-translated
half of those ports is written on your own machine from your own copy of the game, because it is
a translation of that game's binary rather than anything the port authors wrote. The source's
RELEASING.md and each title's README say how.

What the licence covers is the port. The game it runs is not the port authors' to license, and
none of it is in this download.

THE GAME'S FILES ARE STILL NOT IN HERE
--------------------------------------

Worth saying twice. This download is a program that can run the game you own. It contains none
of that game's code, art, music or levels.
