| ParlorNet Turn-based game server for any computer, old or new | |
| Clients | Protocols | Browsers | Telnet programs | Docs | Source |
ParlorNet has two web sites in one style:
Both are HTML 3.2 for any browser with tables, forms and image maps, back to Mac Mosaic 2.0 and Netscape 1.1, at 2400 to 14,400 bit/s. ParlorNet recreates period game-server protocols so that the original game programs, its native clients, can play, and both sites lead with them; the web pages are the fallback. This page is their map, their page frame and the rules the pages keep. Each fact lives on one page; the others link to it.
| Address | Page | What it holds |
|---|---|---|
| /welcome.htm | Welcome | The message of the day (#motd), which holds all of the welcome text, in <pre>; Play now (#play): Sign in (#signin) and New account (#new), each its own form; Other ways in (#ways-in): each protocol this server speaks now with its port, its key linking to the docs site, the telnet command for TELNET, the docs site's Clients page, and the project's home for running your own server; the Games list (#games). /, /index.htm and /index.html redirect here. |
| /games.htm | Games | One row per game in build order: name, players, status here and what it is, in one sentence. Each row is anchored by game type (#reversi, ...). |
| /games/<type>.htm | A game | Players, status here; for programmers, its type spec and its chapter of the protocol guide on the docs site; what the game is, and the rules and options played here; Programs that play it (#frontends): its section of the docs site's Clients page, and this server's Protocols. Backgammon's page says where FIBS is and that ParlorNet is not FIBS. |
| /protocols.htm | Protocols | What this server speaks now, from the core's PRL (docs/protocol.md, Protocols): one row per protocol, key, port, name and what it is, in port order; each key links to its entry in the docs site's protocols reference (protocols.html#KEY). A protocol whose extension is not connected is not listed. |
| /lobby.htm | Lobby | Signed in: the players online, invitations, the tables, a form per game to start a table, and Your account (#account): change your password, sign out, sign out everywhere. |
| /table.htm | A table | Signed in: the game's board and panels, the status and clock, the last events, refresh and resign links, and invitations for an open table. |
| /login.htm | Sign in | The sign-in form (GET; with a session cookie, the lobby). POST signs in only (USER): a name with no account is told so, with a link to New account. The server's steps of every flow (sign-in, new account, password change) are POSTed here, one page each, headed by their flow. |
| /signup.htm | New account | What this server's sign-up asks, and the form for the name wanted (GET). POST starts the sign-up (REG); a taken name is told so, with a link to Sign in. |
| /resign.htm, notices | The resign question; short pages for what could not be done, Not found, and Busy. |
The documentation's old addresses on this site answer with a 301 to the same page on the docs site, the body a plain HTML 3.2 page with the link: /frontends.htm (to index.html, keeping ?plat= and ?arch=, which the docs site's finder reads), /browsers.htm, /telnet.htm, /setup/<id>.htm, /eclipse-68k-fix.htm, /docs/index.htm (to docs.html), /docs/<name>.htm (to docs/<name>.html), and the Eclipse 68k Fix's downloads and screenshot (/download/..., /img/eclipse-68k-fix.gif). When the operator clears site.docs_url, they answer Not found, and no page links the docs.
site.docs_url is a server setting, like site.contribute_url: the admin menus (Server, Docs) or the settings file, else PARLOR_DOCS_URL, else http://docs.parlornet.org/; set to nothing, it is cleared. The core hands it to the web extension on the DOC line of PRL.
| Address | Page | What it holds |
|---|---|---|
| index.html | Clients | The home page. What ParlorNet is for, and the original servers still running (one line each). A summary grid first: example machines down (Mac Plus to a modern computer), the games across (two-letter heads with a key), one linked letter per cell: N a native client, T telnet only, W web only, - nothing yet (native over telnet over web); a cell goes to the native client's setup page when there is only one, else to this page narrowed to the machine at the game, or at Any Game (Generic) Clients for T and W; each machine's name goes to this page narrowed to it. Then the finder, the list of games, and a section per game in build order, anchored by game type (#reversi, ...), with its native clients in one table (Client, Year, OS, Protocol, Setup); a game with none says "No native client yet." After that comes "Play by web or telnet", a link to Any Game (Generic) Clients. Then Your own program (#native), and at the bottom Any Game (Generic) Clients (#generic, also #web and #telnet): every browser and every telnet program, once, in the same kind of table. Each row's Protocol cell is its key, linking to its entry in the protocols reference; a client whose protocol's original server is still running says so in its row. #period, #frontends and #clients are anchors on the list of games. |
| protocols.html | Protocols | Every protocol a ParlorNet server can speak, by key: a summary table (key, usual port, protocol, status), then an entry per key anchored by it (#HTTP, #PARLOR-1, #TELNET, #IOS, #GGS, #FIBS, #OUTLAND): the original server still running, when there is one, in one line; the protocol, its usual port, origin, years in use, what serves it, its status, the games it reaches, the programs that speak it, and its part of the guide (docs/protocols.html). |
| browsers.html | Browsers | What a browser needs (#needs), setting one up (#setup), signing in under each method a server may run (#signin), then each browser under its own anchor (#mill, #netscape, ...): what it runs on, the year, Getting it, its notes. |
| telnet.html | Telnet programs | The same for telnet programs, with movement keys (#keys) and, for each program, whether it sends arrow keys, its colour and line characters. |
| setup/<id>.html | A client's setup | One period game client: what it is and its status, its protocol and key, the original server of its protocol when it is still running, what it runs on and its year, Getting it (#get), setting it up (#setup), signing in under each method a server may run (#signin), known problems (#problems), what works and what does not. |
| eclipse-68k-fix.html | Eclipse 68k Fix | The bug, the fix, how to use it, and its three downloads (download/) with sizes and SHA-256: the only files the docs site carries besides its own images. |
| docs.html | Docs | The docs in groups (for players, for frontend writers, for operators and developers, the last starting with the project's home), then every other doc by folder (#types, #design, #research) and name; with a finder. |
| docs/<name>.html | A doc | A Markdown file from docs/, rendered by adapters/mdhtml.py. A link to another doc goes to its page; to any other file of the repository, to it at the project's home; to http://docs.parlornet.org/, within the site. Each ends with a link to its Markdown at the project's home. |
| 404.html, CNAME, .nojekyll | Not found (GitHub Pages shows it at any missing address), the site's name, and no Jekyll processing. |
The docs site names no server: setup steps say *host* for the name of the server you play on, the ports are the usual ones (a server's Protocols page lists its own), and the sign-in steps are given for every method a server may run. Only docs/ is read for doc pages.
Building it: python3 tools/build_docs.py writes the site into build/docs-site (git-ignored); --out DIR writes elsewhere, into an empty folder or one the tool wrote before (it empties it first). Every link is relative, so the folder opens from disk or any address.
The finders on index.html and docs.html: a script writes a Find box (and, on Clients, Platform and Processor menus) and hides the rows, and the lists or tables left empty, that do not match, with a count. It writes the box only where the browser has the DOM it needs (getElementsByTagName); anywhere else there is no box and every row shows. The page's content is the same with or without it. The Clients page's script reads ?plat=, ?arch= and ?q= from its address, which is how the summary grid's links and the game server's old /frontends.htm?plat=... land on a narrowed list; without the script they land on the full one.
adapters/webstyle.py holds the frame, the palette, the faces and the helpers every page of both sites is built from (frame, h1, h2, p, callout, data_table). A page is:
The lobby, a table and the resign question use the compact frame: one bar with the name and the signed-in navigation (Lobby, Games, Protocols, Docs, Account, Sign out). Those links go through link(), so they carry the action check (x=) and, for a browser without cookies, the session (s=). A game's board markup comes from its module in adapters/games/ and goes into the table page as it is.
The body of a redirect (301, 302) has no frame: browsers follow the redirect without showing it, and a move would otherwise cost the frame's bytes on every click.
All web-safe: the 216 colours that a 256-colour screen shows without dithering.
| Name | Colour | Used for |
|---|---|---|
| PAPER | #FFFFFF | the page |
| INK | #000000 | the text |
| FELT | #006633 | card-table green: the emblem's column and the frame of a callout; never behind text |
| DEEP | #003300 | dark felt: the name and the headings |
| SAGE | #99CC99 | light felt: the navigation bar, the footer and the header row of a table, with dark text |
| IVORY | #FFFFCC | the masthead plate, callouts and every other row of a table |
| LINK, VLINK, ALINK | #003399, #663366, #CC0000 | links: navy, plum once visited, red while pressed |
The green comes from the boards: the Reversi board and the Backgammon table are green, and the emblem is the opening four discs of Reversi on two-by-two felt, 33 pixels square, 655 bytes, made with the site's own GIF encoder and cached like the games' images.
FONT does not carry into table cells in Netscape, so every cell has its own. The docs are set as a manual: their body text and tables are in the browser's own text face (Times, mostly), and only their headings take the site's face. With the frame and headings a long doc grows by under a tenth; a FONT per paragraph and per cell would add a third.
As plain text (Lynx), every page reads in order: the name and tagline, the navigation, the page's heading, its sections, the footer.
Tests check each of these on every page: tests/test_site.py on the game server's site, tests/test_docs_site.py on the docs site.
| These pages cover every ParlorNet server. | Source code | ParlorNet is free software. |