Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Applies to: v10

v10 reader's guide. This guide is the Worldgroup 3.x guide (chapters 1-28, Marc Fountain's text, unchanged) with v10 notes added after the passages they concern, plus chapter 29 (the v10 layer). Three things to know first: (1) Client/Server mode and Active HTML are not in v10 and are marked as such wherever they occur; (2) v10 is built with Visual Studio, not Borland, so the Borland/Phar Lap/MAKEBBS instructions are history (chapter 29, section 29.3); (3) string literals passed to char * parameters crash v10 modules, and most examples in this guide do exactly that (chapter 29, section 29.4, read it before copying any example).

Worldgroup The Major BBS communicates with its users in either of two distinct ways:

...

Terminal mode, the traditional centralized processing approach, andClient/server mode, the newer distributed processing approach. Server Developer’s Guide describes the development environment for Worldgroupthe Major BBS. It explains the internal workings of the Worldgroup Major BBS server and the terminal-mode user interface. You should read this guide first.

...

Client App Developer’s Guide describes how to create Visual Basic applications which run under Worldgroup Manager, the client side of C/S mode. Agent Developer’s Guide describes how to create the server side of C/S mode: agents. Finally, GSBL Guide describes low-level communications functions.

The ideal design for a Worldgroup Major BBS application provides a separate front end for each of the two interface modes. The core application code is then accessed through a common API:

...

If you’re writing an application from scratch, or thoroughly overhauling an existing application, this is the recommended design. For example, Worldgroup’s the Major BBS’s messaging system (E-mail and Forums) has been completely overhauled as compared to its predecessor in The Major BBS. The new messaging system follows this design.

...

From a user’s viewpoint, none of this is apparent. The server code is a black box with two alternative points of access: either a terminal-mode user interface, or a C/S-mode application interface expecting to communicate with a client app running under WGM on the user’s PC.

Developer’s Addendum for Worldgroup v2

Applies to: WG2+

This is an addendum to the Worldgroup Client App Developer’s Guide, Agent Developer’s Guide, and Server Developer’s Guide. It describes the enhancements to the Worldgroup Major BBS development platform that were introduced with Worldgroup v2.0.

...

Applies to: WG2+

Editor’s note: the server-side topics of the addendum are merged into the chapters below (3, 4, 5, 6, 11). The client-side topics are collected in 20-client-side-addendum.md.

Requirements

Applies to: v10

The requirements and installation steps of this chapter (Borland C++ 4.50, the Phar Lap DOS-Extender SDK, SET BORLAND/PHARLAP/MBBS, MAKEBBS.BAT, the 386/486 and DOS 5 requirements) do not apply to v10. A v10 module is built with Visual Studio from a .vcxproj (Win32 and x64) against inc\ and wgserver_lib.lib; see chapter 29, section 29.3. Source written for WG1/WG2/WG3.x must be ported first: chapters 28 and 29.

Applies to: WG3.x

Editor's note: the requirements and installation steps in this chapter (Borland C++ 4.50, the Phar Lap 286|DOS-Extender SDK, SET BORLAND/PHARLAP/MBBS, MAKEBBS.BAT) are the WG1 development environment. Worldgroup 3.12 requires a 32-bit Windows host and supports Borland C++ 5.00 (DOS and NT/95 servers), Microsoft Visual C++ 4.2 (offline NT/95 programs) and Visual Basic 3.00 (client programs). See chapter 21, "Development Tools" and "Worldgroup Development Environment Requirements".

Header check: the 3.2 kit's \WGDEV\SRC also holds bc551-32.mak, bc50-32.mak, bc45.mak and bc31.mak; the addendum names only Borland 5.00. bc551-32.mak (ilink32) still reads the BC50 environment variable (bc551-32.mak:4-13).

...

a 386, 486, or Pentium with at least 4 meg RAMa minimum of 100 meg available disk space, but you may want much moreDOS version 5 or higherWorldgroupThe Client/Server Developer’s Kit for Worldgroupthe Major BBS, which includes:
C source code for Worldgroupthe Major BBS
supporting subroutine libraries
supporting batch, make, and other filesBorland C++ compiler version 4.50 (compatibility kits for other versions may be available from Galacticomm) Microsoft Windows 3.1 or later (in order to install Borland C++ v4.50)Phar Lap 286|DOS-Extender SDK A text editor of your choiceIf you need to create new databases for your application, you will need to purchase Btrieve directly from Btrieve Technologies, Inc.

Server Developer’s Guide assumes:

    You have purchased Worldgroup the Major BBS and the Client/Server Developer’s Kit.You have read Sysop’s Guide for Worldgroupthe Major BBS. You are proficient in using Worldgroup the Major BBS via modem or other interface. You are proficient in managing Worldgroup the Major BBS from the Main Console. You are proficient in the C language. You are proficient at using DOS and IBM-compatible PCs. Knowing assembly language can be helpful too, but it’s by no means required to make extensive use of this development environment.

    See Client App Developer’s Guide for client-side requirements.

    You Can Modify

    ...

    the Major BBS in Stages

    Changes made to Worldgroup the Major BBS fall into either of two broad categories:

    Customizing Custom tailoring the functionality of one specific WorldgroupMajor BBS

    Developing Programming an Add-on Option for Worldgroupthe Major BBS

    The main purpose of Server Developer’s Guide is to help developers create new products for Worldgroupthe Major BBS, but it will also be helpful if you’re running a Worldgroup Major BBS and wish to customize it by making changes or additions to the source code. From simple cosmetic changes to the authoring of new applications, Worldgroup the Major BBS is as flexible as you require.

    ...

    With Only The Baseline Package

    ...

    You can customize the values of several thousand CNF options. These allow you to steer each baseline module through a set of pre-defined courses: charging for messages sent vs. not charging, requiring keys for various activities, even fine-tuning the frequency of various events.

    ...

    Menu Tree page settings allow you to change how the facilities of your Worldgroup Major BBS are presented to your users. You can control both the layout and the appearance of your system here.

    ...

    With The Client App Developer’s Kit

    ...

    Applies to: v10

    Not in v10. The Client/Server (Visual Basic client app) mode was removed in v10 (MBBS10.txt section 2; the v10 history has the commit "Initial port of GALTELE including removal of AHTML and CS related code"). Read this passage as WG1-3.x history only.

    ...

    Client App Developer’s Guide focuses on these issues, directing you through the Visual Basic programming environment.

    ...

    With The Client/Server Developer’s Kit

    ...

    Applies to: v10

    Not in v10. The Client/Server (Visual Basic client app) mode was removed in v10 (MBBS10.txt section 2; the v10 history has the commit "Initial port of GALTELE including removal of AHTML and CS related code"). Read this passage as WG1-3.x history only.

    ...

    You can also create the server side of completely new applications. Finally, you can change the Worldgroup Major BBS server baseline software itself: the Main Console, etc.

    Server Developer’s Guide focuses on the server side of applications, particularly the internal processing and terminal-mode interface areas. Agent Developer’s Guide focuses on the C/S-mode front end issues. GSBL Guide describes the communications-level functions of the optimized machine-code engine at the heart of Worldgroupthe Major BBS.

    ...

    With The Extended C Source Developer’s Kit

    ...

    You can change almost everything else in the Worldgroup Major BBS environment: the CNF program itself, WGSDRAW, the Menu Tree design program, etc.

    Either Way, You Need a Developer-ID

    *excluding INSTALL.EXE, DISK1.DID, DISK2.DID, etc.

    ...

    Text variable names (see page 102)CNF options and levels (see page 79)Statistics screen names (see page 276)Source filenames should also use the Developer-ID prefix to avoid name collision. Even if you use a separate directory for your source files, your object files will reside in the same directory as all other object files from all other developers. The need for unique source and object filenames is not as strict as the need for unique names of files associated with running Worldgroup the Major BBS and Add-on Options, however.

    While it would be a disaster for a Sysop to buy two Add-on Options from different sources and have them not work because of a filename collision, it would be merely an annoyance for someone who buys your source code to run into name collisions. The latter is going to happen to a far smaller group of people (Worldgroup the Major BBS developers and customizers), and those people are more likely to be able to recover from it themselves by manually renaming some of the files.

    Registering Your Developer-ID

    Galacticomm maintains a master list of Developer-IDs to help Worldgroup the Major BBS developers avoid choosing one which is already in use. To register your Developer-ID with us, call (305) 583-5990 and ask for the ISV Program Manager. In this manual we’ll use DDD to represent an example of a Developer-ID.

    Installation

    Applies to: WG3.x

    Editor's note: steps 2 through 14 below are the WG1 procedure. In WG3.x the build tree is \WGDEV (INC, BIN, LIB, HELP, SRC, VCPROJ), controlled by the environment variables BC50, DOSEXT, WGDEV, WGDOS, WGNT, BUDOS, MVC42 and VB3; projects are built with MKNT, MKDOSL, MKDOSP or MAKEWGS and .MAK files that include $(WGDEV)\src\GCRULES.MAK; there is no %MBBS%\SRC\MAKEBBS.BAT with one cd/MAKE pair per project. The PATH entry is \WGDEV\BIN (chapter 21, "Environment Variables", "PATH Statement", "Compilation Batch Files"). Existing WG1/WG2 source must be ported first: see chapter 28.

    The following procedure has been designed to apply to everyone who purchases C source code from Galacticomm. It assumes you already have a way to edit text files like .BAT files.

    Several products are discussed here, and several sections may not apply to you. Whether you’re building a development environment for a baseline-only WorldgroupMajor BBS, or for a large-scale system with dozens of Add-on Options, including some of your own, please use this as your central reference, and follow the steps very carefully.

    To create a development environment for Worldgroup the Major BBS on your computer:

    1. If you haven’t already installed Worldgroup’s the Major BBS’s baseline, put the first disk in A: and type: A:INSTALL enter

    All documentation assumes you use the default directory \WGSERV for your development environment, although you can install Worldgroup the Major BBS elsewhere if necessary. The directory will be created automatically for you if it does not already exist.

    ...

    Before you install the source code and other items, it’s a good idea to bring Worldgroup the Major BBS online and become familiar with it. See Sysop’s Guide.

    ...

    4. In order to compile or link software on the server, you’ll need to have the following environment variables set:

    MBBS to the path your Worldgroup Major BBS server is installed in;
    BORLAND to the path your Borland C++ is installed in; and
    PHARLAP to the path your Phar Lap 286 is installed in.

    Also, put the compiler BIN directory, the DOS-Extender BIN directory, and the Worldgroup Major BBS SRC directory in your PATH statement.

    For example, you could have something like this in your AUTOEXEC.BAT file:

    Code Block
    :
    SET BORLAND=C:\BC45
    SET PHARLAP=C:\RUN286
    SET MBBS=C:\WGSERV
    :
    PATH=C:\DOS;%BORLAND%\BIN;%PHARLAP%\BIN;%MBBS%\SRC
    :

    Because you’ve changed AUTOEXEC.BAT, reboot your PC before continuing.

    ...

    Notice that you cannot use the environment variables here, but must use the literal path names instead, all the more reason to install software in the default locations.

    TLINK.CFG

    Code Block
    -L\BC45\LIB;\RUN286\BC4\LIB;\WGSERV\DLIB

    TURBOC.CFG

    Code Block
    -I\BC45\INCLUDE;\RUN286\INC;\WGSERV\SRC
    -L\BC45\LIB;\RUN286\BC4\LIB;\WGSERV\DLIB
    1. Get and install Borland C++ 4.50 Huge Model Support. Dial (617) 661-1009 and log onto Phar Lap’s BBS. Go into File Libraries, select library GALACT, and download the file named PLPAT4.ZIP into your \RUN286\BC4\LIB directory, then unzip it and install it:

    ...

    7. Put the first disk of the Worldgroup Major BBS Extended C Source Developer’s Kit in A: and type A:INSTALL enter

    8. The master make file MAKEBBS.BAT and the master debugging make file MAKEBBSD.BAT are both located in the SRC directory beneath the Worldgroup Major BBS server main directory (\WGSERV\SRC). Both files contain instruction pairs for each part of your project. The first line in each pair is a CD to this directory, referred to using an environment variable (%MBBS%\SRC), and the second line is the MAKE command for one of the .MAK files. The next-to-the-last line in each batch file is a CD to the %MBBS% directory (\WGSERV), and the last line is the batch label :DONE to mark the end of the file.

    For every %MBBS%\SRC\.MAK file that comes with the Extended C Source Developer’s Kit, you need to insert another instruction pair in MAKEBBS.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\src           <-- add verbatim for each additional *.MAK file
    MAKE -fwgsxyz.mak               <-- add for each additional *.MAK file, e.g. WGSXYZ.MAK
    cd %MBBS%                       <-- leave as next-to-the-last line of each batch file
    :DONE                   <-- leave as last line of each batch file

    For every %MBBS%\SRC\.MAK file that comes with the Extended C Source Developer’s Kit, you need to insert a debugging version of this same instruction pair in MAKEBBSD.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\src            <-- add verbatim for each additional *.MAK file
    MAKE -DDEBUG -fwgsxyz.mak <-- add for each additional *.MAK file, e.g. WGSXYZ.MAK
    cd %MBBS%                        <-- leave as next-to-the-last line of each batch file
    :DONE                    <-- leave as last line of each batch file

    Only if you purchased Btrieve to create your own databases, do step 9:

    ...

    12. The master make file MAKEBBS.BAT and the master debugging make file MAKEBBSD.BAT are both located in the SRC directory beneath the Worldgroup Major BBS server main directory (\WGSERV\SRC). Both files contain instruction pairs for each part of your project. The first line in each pair is a CD to this directory, referred to using an environment variable (%MBBS%\SRC), and the second line is the MAKE command for one of the .MAK files. The next-to-the-last line in each batch file is a CD to the %MBBS% directory (\WGSERV), and the last line is the batch label :DONE to mark the end of the file.

    Insert another instruction pair in %MBBS%\SRC\MAKEBBS.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\src           <-- add verbatim for each additional *.MAK file
    MAKE -fgalxyz.mak               <-- add for each additional *.MAK file, e.g. GALXYZ.MAK
    cd %MBBS%                       <-- leave as next-to-the-last line of each batch file
    :DONE                   <-- leave as last line of each batch file

    Insert a debugging version of this same instruction pair in %MBBS%\SRC\MAKEBBSD.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\src            <-- add verbatim for each additional *.MAK file
    MAKE -DDEBUG -fgalxyz.mak <-- add for each additional *.MAK file, e.g. GALXYZ.MAK
    cd %MBBS%                        <-- leave as next-to-the-last line of each batch file
    :DONE                    <-- leave as last line of each batch file

    Instead of GALXYZ.MAK use the name of whatever .MAK file comes with the C source code of the Add-on Option. This step allows you to use MAKEBBS and MAKEBBSD to properly follow up on any and all changes you may make to the source files in the Add-on Options.

    ...

    13a. Put the C source code you write in %MBBS%\SRC alongside the source code we wrote. For every .MAK file you create, insert another instruction pair in MAKEBBS.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\SRC           <-- add verbatim for each additional *.MAK file
    MAKE -fdddxyz.mak               <-- add for each *.MAK file you create, e.g. DDDXYZ.MAK
    cd %MBBS%                       <-- leave as next-to-the-last line of each batch file
    :DONE                   <-- leave as last line of each batch file

    Insert a debugging version of the same instruction pair in MAKEBBSD.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\SRC            <-- add verbatim for each additional *.MAK file
    MAKE -DDEBUG -fdddxyz.mak <-- add for each *.MAK file you create, e.g. DDDXYZ.MAK
    cd %MBBS%                        <-- leave as next-to-the-last line of each batch file
    :DONE                    <-- leave as last line of each batch file

    or:

    13b. Put the C source code you write in %MBBS%\DDD (substituting your own Developer-ID for DDD). For every .MAK file you create, insert another instruction pair in MAKEBBS.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\DDD           <-- add verbatim for each additional *.MAK file
    MAKE -fdddxyz.mak               <-- add for each *.MAK file you create, e.g. DDDXYZ.MAK
    cd %MBBS%                       <-- leave as next-to-the-last line of each batch file
    :DONE                   <-- leave as last line of each batch file

    Insert a debugging version of the same instruction pair in MAKEBBSD.BAT ahead of the last two lines of each file:

    Code Block
    cd %MBBS%\DDD            <-- add verbatim for each additional *.MAK file
    MAKE -DDEBUG -fdddxyz.mak <-- add for each *.MAK file you create, e.g. DDDXYZ.MAK
    cd %MBBS%                        <-- leave as next-to-the-last line of each batch file
    :DONE                    <-- leave as last line of each batch file

    Now, test your development environment:

    ...

    This compiles and links \WGSERV\MAJORBBS.EXE, almost all \WGSERV\.DLL files, and some \WGSERV\.EXE basic utilities. The process may take many minutes depending on your computer’s processing power. Keep a sharp eye out for warnings or error messages.

    15. Bring Worldgroup the Major BBS online and test it: transfer a file via modem, for example.

    Your Worldgroup Major BBS development environment is up and running!

    Installation Software for Your Own Add-on Option

    TPDINST.EXE is now shipped as part of the Client/Server Developer’s Kit. You are licensed to redistribute it as INSTALL.EXE in order to install your Worldgroup Major BBS add-ons.

    Applies to: v10

    Not in v10. The Client/Server (Visual Basic client app) mode was removed in v10 (MBBS10.txt section 2; the v10 history has the commit "Initial port of GALTELE including removal of AHTML and CS related code"). Read this passage as WG1-3.x history only.

    Most of the files you distribute will be combined into .ZIP compressed files on your release floppy diskette(s). The first floppy will contain INSTALL.EXE, of course, and also the file DISK1.DID. This file indicates to the installation program that it is the first in a sequence of at least one disk. The contents of DISK1.DID also convey information. For example:

    Code Block
    2  150  7000000  NOBBS

    Here is what these sample entries represent:

    ...

    To run your own batch file or program after INSTALL.EXE completes, be sure to include at least one .MDF file with an Install: directive (see page 34 for details) somewhere in one of your .ZIP files.

    Note: Worldgroup the Major BBS automatically deletes whatever file is named in an .MDF Install: directive after it’s done running.

    .RLN Release Notes

    You can include release notes in an .RLN file in one of your .ZIP files. INSTALL will automatically display them to the operator. We use this to display WGSMAIN.RLN to Sysops when they first install Worldgroupthe Major BBS. That file contains very up-to-date information and it makes sure the Sysop gets a chance to read it. Note: be sure your .RLN’s lines are no more than 76 characters long.

    How .MSG Files are Updated

    Any .MSG files included in your .ZIP files are automatically merged with .MSG files that exist already on the Sysop’s system. This way their offline CNF option settings are preserved when they update to a new version of your software.

    ...

    An alternate form of the .DID files on each of your release diskettes adds a language name at the end. For example, DISK1.DID might contain:

    Code Block
    2  150  7000000  English/RIP

    This is used in certain special situations. When a language name appears as the fourth parameter in a .DID file, it tells the INSTALL program to be sure to force all text in that language onto the receiving WorldgroupMajor BBS, and not to mix it with any text the Sysop may already have in that language.

    ...

    You can use this feature with any user language, such as Spanish/RIP or German/RIP. If you use this feature in your Add-on Option, the Sysop will be given the option (called UPDATE NEW) of mixing his text in the specified user language with yours, but he’ll be strongly encouraged to allow all of your text to take precedence (that option being called UPDATE ALL).

    ...

    Contents  |  Next: Major BBS v10: 02 The Major BBS’s Environment