The game hub for Commodore computers: the Commodore kit, version 0.1.0
=========================================================================

The programs for the Commodore side of the game hub at
play.commodoreonline.com: playlib, the text client, the lobby and the
example games, built and with their sources. MIT licensed (LICENSE.txt).

The documentation is on the web:

  https://commodoreonline.com/docs/gamehub/                  start here
  https://commodoreonline.com/docs/gamehub/playlib/          playlib in full
  https://commodoreonline.com/docs/gamehub/text-worlds/      the text client


Disks
-----

  disks/textclient.d64   The text client, for the C64 and the PET with BASIC 4.
                         LOAD"*",8 and RUN: the boot program finds the machine
                         and the network device and loads what they need
  disks/trails.d64       The lobby and the example game TRAILS for the C64


playlib: the library (playlib/)
-------------------------------

  build/playlib-flyer.prg    C64, the Flyer                     at $C000
  build/playlib-swift.prg    C64, a SwiftLink-type cartridge    at $C000
  build/playlib-rs232.prg    C64, a modem on the user port      at $C000
                             (up to 2400 baud)
  build/playlib-pet.prg      PET with BASIC 4, the Flyer        at $7000
  build/playlib-*.lib        the C64 builds for cc65 programs (cc65 2.19 or
                             later), with src/playlib.h
  build/*.lbl                labels for VICE's monitor
  src/                       the sources (ca65), playlib.inc for machine
                             language, playlib.h for C

A game loads the build for the player's device and calls it with SYS (the
entries are the same on every build, less 20480 on the PET). playlib's page
on the web lists them.


The text client (textclient/)
-----------------------------

  build/textclient.prg       the boot program (TEXTCLIENT on the disk)
  build/textclient-c64.prg   the client for the C64
  build/textclient-pet.prg   the client for the PET with BASIC 4, 40 or 80
                             columns
  src/                       the sources: textclient.s for both machines,
                             boot.bas


The lobby (lobby/) and the examples
-----------------------------------

  lobby/                     The ready-made lobby for C64 games, in BASIC on
                             playlib: build/lobby.prg, and lobby.bas
  trails/                    TRAILS, a real-time game for two in machine
                             language on playlib. build/game.seq is the GAME
                             file that tells the lobby the game and the hub
  tictac/                    Tic-tac-toe in BASIC on a Flyer's tcp: channel,
                             with no library
  tictac-play/               The same on the Flyer's play: channel, which logs
                             in by itself
  tictac-turns/              A turn-based tic-tac-toe, a move per session

tictac and tictac-turns connect to 127.0.0.1 port 6502: the development hub,
on the same PC as VICE. For another hub change line 20 (hs$ and hp$).
tictac-play goes where the Flyer's play: channel goes, the hub at
play.commodoreonline.com unless the Flyer is set otherwise.


Building from the sources
-------------------------

Each folder's build.sh rebuilds it (a POSIX shell: Linux, macOS, or Git Bash
on Windows). They need cc65's ca65 and ld65 (CC65_BIN: their folder), and
VICE's petcat and c1541 for BASIC and disks (VICE_BIN: VICE's bin folder).
textclient/build.sh and trails/build.sh also build what they put on their
disks, so the folders must stay side by side. The tic-tac-toe programs are
plain BASIC: petcat -w2 -o tictac.prg -- tictac.bas
