| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| module:install-xtrn [2021/02/13 13:05] – [Example install-xtrn.ini] mortifis | module:install-xtrn [2025/08/25 18:25] (current) – Started cleaning this page up digital man |
|---|
| |
| |
| This script parses a ''.ini'' file (default filename is ''install-xtrn.ini'') and installs the external programs defined within into the Synchronet BBS configuration file: ''[[dir:ctrl]]/xtrn.cnf''. The programs defined within this file can by online programs (a.k.a. Doors), editors, or events. | This script parses a ''.ini'' file (default filename is ''install-xtrn.ini'') and installs the external programs defined within into the Synchronet BBS configuration file: ''[[dir:ctrl]]/xtrn.ini''((xtrn.cnf in older versions of Synchronet)). The programs defined within this file can by online programs (a.k.a. Doors), message editors, or timed events. |
| |
| This script can by invoked in a more user-friendly automated fashion by running [[person:echicken]]'s [[module:xtrn-setup]] module. | This script can by invoked in a more user-friendly automated fashion by running [[person:echicken]]'s [[module:xtrn-setup]] module instead. |
| |
| If the door is included with Synchronet, or Synchronet already has a configuration for it (in ''xtrn/3rdp-install''), you can use the ''install-xtrn.js'' script to install your door. For third party doors, you should extract the door files into your external directory first, and perform any required unpacking/installing of the files. Once the final executable file is in place, Synchronet can check for a file signature match and install the door configuration if it has a matching known configuration for it. | If the door is included with Synchronet, or Synchronet already has a configuration for it (in ''xtrn/3rdp-install''), you can use the ''install-xtrn.js'' script to install your door. For third party doors, you should extract the door files into your external directory first, and perform any required unpacking/installing of the files. Once the final executable file is in place, Synchronet can check for a file signature match and install the door configuration if it has a matching known configuration for it. |
| |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ |
| ^ -auto ^ Don't prompt for a list of doors to install ^ | | -auto | Don't prompt for a list of doors to install | |
| ^ -debug ^ Shows what would happen (does not make changes) ^ | | -debug | Shows what would happen (does not make changes) | |
| ^ -overwrite ^ Overwrite already-installed door ^ | | -overwrite | Overwrite already-installed door | |
| |
| ===== Third Party External Programs (Doors) ===== | ===== Third Party External Programs (Doors) ===== |
| |
| Configs are located in xtrn/3rdp-install to support installing third party external programs. These configs are version-specific and are based on a MD5 hash against the game's executable. | Configurations are located in ''[[dir:xtrn]]/3rdp-install'' to support the installing popular third party doors. These configurations are version-specific and are based on a MD5 hash of the door's primary executable file. |
| |
| The general instructions are: | The general instructions are: |
| - Download the file from the program author's website | - Download the file from the program author's website |
| - Extract the file into the destination directory of your xtrn folder | - Extract the file into the destination directory of your xtrn folder |
| - Inside that directory, do any actions you need to get the files into their final state. For example, extracting any included zip files, running any uncompressors or installer programs, installing any patches (like tppatch for Turbo Basic programs), etc. | - Inside that directory, do any actions you need to get the files into their final state. For example, extracting any included zip files, running any uncompressors or installer programs, installing any patches (like ''tppatch'' for Turbo Basic programs), etc. |
| - Review the sysop documentation for the program | - Review the sysop documentation for the program |
| - Run the install-xtrn.js. If it finds a match (based on a MD5 sum of the executable), it will give you the option to install the program and decide which external section to place it into. If it does not give you the option, then either no configuration exists in xtrn/3rdp-install for this program or this particular version of the program, or you may have missed a step preparing the files | - Run the ''install-xtrn.js''. If it finds a match (based on a MD5 sum of the executable), it will give you the option to install the program and decide which external section to place it into. If it does not give you the option, then either no configuration exists in ''[[dir:xtrn]]/3rdp-install'' for this program or this particular version of the program, or you may have missed a step preparing the files |
| - Perform any required tasks according to the sysop documentation, such as resetting the program, etc. | - Perform any required tasks according to the sysop documentation, such as resetting the program, etc. |
| - Apply any registration codes you have for the program | - Apply any registration codes you have for the program |
| ;exec ?install-xtrn ../xtrn/minesweeper | ;exec ?install-xtrn ../xtrn/minesweeper |
| |
| install-xtrn.js reads the directory specified install-xtrn.ini (ie: ../xtrn/minesweeper/install-xtrn.ini | ''install-xtrn.js'' reads the directory specified install-xtrn.ini (e.g.: ../xtrn/minesweeper/install-xtrn.ini) |
| |
| The .ini root section keys supported: | The .ini root section keys supported: |
