PHP Classes

File: docs/userguide/index.md

Recommend this page to a friend!
  Packages of Matthew Asham   Binkterm PHP   docs/userguide/index.md   Download  
File: docs/userguide/index.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Binkterm PHP
Bulletin board system based on the Web
Author: By
Last change:
Date: 5 days ago
Size: 18,232 bytes
 

Contents

Class file image Download

Welcome to the BBS ? User Guide

Welcome aboard! This guide will walk you through everything this BBS has to offer, from your personalized dashboard to the global FTN (Fido Technology Network) echomail networks connecting thousands of sysops and users worldwide. Whether you're a BBS veteran or brand-new to the hobby, you'll find something here to explore and enjoy.

Table of Contents

  1. Your Dashboard
  2. Echomail: Global Forums
  3. Message Reader
  4. Netmail: Private Messages
  5. Local and Networked Chat
  6. Doors: Games & Applications
  7. File Areas
  8. Exploring the BBS Networks
  9. Radio & Mesh Access (PacketBBS)
  10. Your Profile & Settings
  11. Getting Help

Your Dashboard

The Dashboard is your home base. As soon as you log in, it gives you a quick snapshot of everything happening on the BBS and across the networks you're connected to.

What You'll Find on the Dashboard

  • System News ? Announcements and news posted by the sysop.
  • Subscribed Echo Areas ? A list of the echo areas you follow, with quick links to jump into each one.
  • Unread Netmail and Echomail counts ? At a glance totals of your unread private messages and echomail.
  • Shoutbox ? A live quick-chat area for shouting out to other users.
  • Voting Booth ? Active polls you can vote on and see results for.
  • Referral Link ? Share your personal referral link to invite new users to the system.
  • BBS Advertisements ? Listings for other BBSs you might enjoy.

Quick Navigation

The navigation bar at the top of every page gives you fast access to all major sections. On mobile, tap the hamburger menu icon to expand it.

> Tip: You can manage which echo areas appear on your dashboard from the Subscriptions page in your user menu.

Echomail: Global Forums

Echomail is the heart of the FTN network ? a system of public message boards that has been connecting BBS users since the 1980s. When you post a message in an echo area, it travels automatically to every other BBS on that network that subscribes to the same area. Within hours (sometimes minutes), users around the world can read and reply.

What Makes Echomail Special

Unlike a typical web forum, echomail messages are distributed ? there's no single server. Your message becomes part of a living, global conversation that propagates from BBS to BBS. It's decentralized, resilient, and community-driven.

Two Ways to Read Echomail

There are two echomail views to choose from:

  • Forum-style echo area list ? A traditional list of echo areas organized by network or interest. Browse areas, pick one, and read its messages. Good if you like to focus on one area at a time.
  • Integrated message reader ? An all-in-one view combining your subscribed areas and interests into a single reading experience. Ideal for catching up across multiple areas without switching between them.

Browsing Echo Areas

Echo areas can be browsed and filtered by network (e.g., FidoNet, DoveNet, FSXNet) or by interest (topic categories such as tech, ham radio, vintage computing, and more). Each area listing shows:

  • Area name ? The unique identifier for this forum (e.g., `DOVE-NET.GENERAL`, `FSXNET.CHAT`)
  • Network ? Which FTN network this area belongs to
  • Message count ? How active the area is
  • Last post ? When the most recent message arrived

Reading Messages

Click any echo area to open its message list. You can switch between two display modes:

  • Threaded view ? Replies are grouped under the original post so you can follow the flow of a discussion.
  • Flat view ? Messages are shown in chronological order, one after another.

Other things you'll encounter in messages:

  • Quoted text ? When someone replies, they typically quote a portion of the original message (shown in a distinct style). This is a long-standing BBS tradition.
  • Tearlines and origin lines ? At the bottom of each message you'll see a tearline (`---`) and an origin line showing the sender's BBS address. These are standard FTN formatting conventions.
  • ANSI art ? Some messages include colorful ANSI art rendered right in the browser.

Posting a Message

To reply to a message, click the Reply button inside any message. To start a new thread, click New Message in the echo area view.

Your message will be queued and sent out to the network on the next mail exchange (typically within minutes to a few hours, depending on the network).

> Netiquette tip: Keep quoted text to a minimum ? quote only the portion you're responding to directly. This is a courtesy for users on slow or metered connections.

Subscribing to Echo Areas

You manage your echo area subscriptions from your personal Subscriptions page, found in your user menu. From there you can browse all available areas and toggle which ones you follow. Your subscriptions determine which areas appear in the integrated message reader and on your dashboard.

If your BBS has Interests configured, you can also set topic interests from your user menu to get personalized area recommendations.

Message Reader

The web message reader is used in both Echomail and Netmail. When you open a message, it appears in a pop-up reader with buttons for moving to the previous or next message, changing the display mode, downloading the message, and replying.

If you prefer using the keyboard, the message reader supports these shortcuts:

  • Left Arrow / Right Arrow ? Move to the previous or next message
  • A ? Cycle through available viewer modes such as Auto, ANSI, Amiga ANSI, PETSCII, and Plain Text
  • D ? Download the current message
  • F ? Toggle full-screen mode for the reader
  • ? or H ? Show or hide the keyboard shortcuts help overlay
  • Esc ? Close the message reader

On touch devices, you can also swipe left to move to the next message and swipe right to move to the previous message. If you swipe within content that scrolls horizontally (such as ANSI art), the content scrolls first; the navigation gesture only triggers when the content is already at its edge.

> Tip: The same shortcuts work in both the echomail reader and the netmail reader.

Netmail: Private Messages

Netmail is echomail's private counterpart ? direct, one-to-one messages addressed to a specific user on a specific BBS. Think of it as FTN email.

Sending Netmail

To send a netmail, click Compose in the navigation bar and choose Netmail. You'll need to address it using the recipient's FTN address ? for example, John Doe @ 1:218/700 ? or you can look up a user by searching the Nodelist.

You can also send netmail directly to a user on this BBS by simply choosing their username from your contacts.

Reading Your Netmail

Click Netmail in the navigation bar. Unread messages are highlighted. Netmail is private ? only you and the recipient can see it.

> Note: Netmail delivery depends on your BBS having a network path to the destination. If a message can't be delivered, your sysop can help troubleshoot.

Local and Networked Chat

Local Chat

Local chat lets you communicate in real time with other users currently on this BBS. It's a great way to connect with fellow members of your local BBS community.

MRC Chat

MRC (Multi-Relay Chat) extends your reach beyond this BBS, allowing you to chat with users on other bulletin board systems in real time. If you enjoy the idea of a live conversation that spans multiple BBSs around the world, MRC is the place to be.

Doors: Games & Applications

Doors are interactive programs you run through the BBS ? from classic text adventure games and real-time strategy to bulletin boards, trivia contests, and utilities. They're called "doors" because they open a gateway from the BBS into a separate application.

Types of Doors

This BBS supports several types of doors:

  • Web Doors ? Modern HTML5 games and applications that run right in your browser. No special client needed.
  • Classic DOS Doors ? Authentic vintage door games running in a DOSBox emulator, rendered in your browser with full ANSI color support.
  • Native Doors ? Applications running natively on the server, accessible via Telnet or SSH.

Playing a Door Game

Click Doors in the navigation bar to see what's available. Each door listing shows a description and what type of door it is. Click Play to launch it.

> Tip: Some door games maintain persistent scores and player rankings across sessions. Check the leaderboard!

File Areas

File areas are shared repositories of downloadable files organized by topic ? classic software, ANSI art packs, utilities, games, documentation, and more.

Browsing Files

Click Files in the navigation bar to see all available file areas. Each area has a name and description. Click an area to browse its contents.

Downloading Files

Click a file's name or the Download button to grab it. File sizes are shown so you know what you're getting.

Uploading Files

If uploads are enabled, you'll see an Upload button inside a file area. Share your own files with the community ? vintage software you've preserved, your own programs, or ANSI artwork you've created.

> Note: Uploaded files are reviewed by the sysop before appearing publicly.

Public File Library

Some files may be available to guests before login ? check the Public Files link if you'd like to browse without registering first.

Exploring the BBS Networks

One of the most exciting aspects of FTN networking is that this BBS is just one node in a vast interconnected web of systems spanning the globe. You can explore that world right from your browser.

The Nodelist

The Nodelist is the FTN network's phone book ? a comprehensive directory of every registered BBS node. It includes the system name, sysop, location, network address, and connection details.

Click BBS Lists > Nodelist in the navigation to open the nodelist browser. You can:

  • Search by system name, sysop name, location, or FTN address
  • Filter by zone or network
  • View full details for any node ? click a system name for its complete profile
  • View on Map ? geocoded systems appear on an interactive world map

The BBS Directory

The BBS Directory is a curated list of known Bulletin Board Systems, automatically discovered through network activity and supplemented with manually curated entries. It's a great way to find new BBS systems to visit via Telnet or SSH.

Click BBS Lists > BBS Directory to browse. Each entry shows:

  • BBS Name and Sysop
  • Location
  • Telnet address ? with a direct connect link if your browser supports it
  • Last seen ? when this system was last observed active on the network

> Did you know? You can add your own BBS to the directory! Click Add Your BBS to submit a listing for review.

Understanding FTN Addresses

Every node on the FTN network has a unique address in the format Zone:Net/Node ? for example, 1:218/700 or 21:1/100.

| Part | What it means | |------|---------------| | Zone | In some FTNs, a major geographic or organizational division (e.g., Zone 1 = North America, Zone 2 = Europe). In others, the zone number identifies an independent network entirely ? such as FSXNet or LovlyNet. | | Net | A regional network within a zone | | Node | An individual BBS within that net | | Point | An optional sub-address for a user on a node |

Multiple FTN networks (FidoNet, FSXNet, AgoraNet, DoveNet, and others) operate independently but use the same addressing convention.

Radio & Mesh Access (PacketBBS) {#radio-mesh-access-packetbbs}

PacketBBS is an access method that lets you read and post on the BBS from a packet radio or mesh radio device ? even without internet access. It uses short, bandwidth-efficient text commands designed to work over low-speed radio links.

If you're a ham radio operator or use a mesh radio device such as a MeshCore or Meshtastic node, and your sysop has configured a PacketBBS bridge, you can log in and use the BBS directly from your radio.

What You Can Do

  • Read and reply to netmail (private messages)
  • Browse and post in echomail areas
  • Read bulletins posted by the sysop
  • See who is currently online

How to Set Up Radio Access

There are three setup steps. All are done through the BBS web interface before you head to the radio.

Step 1 ? Enroll a PacketBBS Authenticator

PacketBBS uses a one-time-password (TOTP) app instead of a plain password to keep your login secure over the air.

  1. Log in to the web interface.
  2. Go to Settings ? Account.
  3. Find PacketBBS Authenticator and click Set up authenticator.
  4. Scan the QR code with any TOTP app (Google Authenticator, Aegis, etc.) or enter the secret manually.
  5. Enter the 6-digit code shown by the app to verify enrollment.

Step 2 ? Find a bridge node on your mesh

You need a bridge node that is reachable from your radio ? either nearby, or connected to the same mesh network you are on.

Go to BBS Lists ? PacketBBS Nodes. Each listed node shows its location and interface type. Find one that is on your mesh or close enough to hear your radio. Note its name; you will select it as your Companion Radio in the next step.

> Tip: Each node listing has a QR code. Scanning it adds the bridge as a contact in your MeshCore app, which helps ensure the bridge can hear you and vice versa.

Step 3 ? Register your radio

The bridge node needs to know about your radio so it can relay traffic to you. Register it under Settings ? MeshCore Radio:

  1. Go to Settings ? MeshCore Radio.
  2. Click Register a radio.
  3. Enter your radio's full 64-character public key, or use the QR scanner button to fill it in directly from your MeshCore app.
  4. Select the bridge node you identified in Step 2 as your Companion Radio.
  5. Save. If your full public key is already known, the BBS will automatically add your radio to the bridge's contact list. Otherwise it will be claimed when the bridge next hears from you.

Once all three steps are done, send this from your radio:

LOGIN <username> <6-digit-code>

Your TOTP code changes every 30 seconds, so type it quickly. After a successful login, any unread bulletins are listed automatically.

Command Summary

| Command | Short form | What it does | |---|---|---| | HELP | H | Show a quick command reference | | HELPFUL | ? | Show the full command list | | LOGIN <user> <code> | L <user> <code> | Log in with your TOTP code | | WHO | W | See who is online | | STATUS | U | Show current context (area, message, or draft) | | AREAS | A | List your subscribed echo areas | | AREA <tag> | T <tag> | Open an echo area | | MAIL | N | List your netmail | | READ <id> | R <id> | Read a message | | REPLY <id> | Y <id> | Reply to a message | | SEND <user> <subject> | S <user> <subject> | Compose a new netmail | | POST | EP | Post in the current echo area | | BULLETINS | BU | List bulletins; BU <id> reads one | | /SEND | /S or . | Send a message you are composing | | /CANCEL | /C | Cancel a message in progress | | MORE | M | Next page | | BACK | B | Previous page | | Q | ? | Exit the current area, or end the session at the top level | | QUIT | ? | End the session from anywhere |

> Tip: Commands are not case-sensitive. help, HELP, and Help all work the same way.

Your Profile & Settings

Personalize your experience and manage your account from the Settings and Profile pages.

Profile

Your public profile shows your username, real name, location, and a short "about me" bio. Other users can view your profile.

Settings Highlights

There are numerous settings available to custom tailor your experience on the BBS. Some highlights include:

  • Theme ? Choose from several visual themes including Light, Dark, Amber terminal, Green terminal, and Cyberpunk.
  • Fonts ? Select your preferred font for reading messages and browsing the BBS.
  • Timezone ? Set your timezone so all dates and times are displayed in your local time.
  • Default echo area view ? Choose whether the Echomail link takes you to the integrated message reader or the forum-style echo area list.
  • Message threading ? Control whether messages are displayed in threaded or flat view by default.
  • Inline Media Rendering ? Choose whether supported media links in messages are rendered inline while reading, including images, video, audio, and platform embeds when allowed by the sysop, network, and area settings.
  • Signature ? Add a default signature that gets appended to your echomail and netmail messages.
  • Tearline ? Customize the tearline that appears at the bottom of your outgoing messages.
  • Ignored users ? Manage a list of users whose messages you'd prefer not to see.
  • Notification settings ? Control which events trigger notifications for you.
  • Password ? Change your account password at any time.
  • AI access ? Configure access to the BBS via AI integrations.

Getting Help

If you have questions or run into any trouble, there are several ways to get help:

  • Ask in Echomail ? Post in a relevant echo area. The FTN community is friendly and full of experienced users happy to help.
  • Send Netmail to the Sysop ? Your sysop's address is listed on the About page. Don't hesitate to reach out directly.
  • House Rules ? Review the house rules (accessible from the footer) to understand community expectations.

Welcome to the BBS community ? enjoy exploring!