Installation Guide

This guide will help you install and configure openRoads on your Synchronet BBS system.

Prerequisites

• Synchronet BBS software installed and configured

• Go 1.23 or later installed on your system

• Basic knowledge of terminal commands

Installation Steps

1. Download the Software

Choose one of the following methods:

Option A: Download a pre-built binary

1. Visit the Releases page

2. Download the appropriate binary for your system:

   • Linux: openroads-linux-amd64

   • Windows: openroads-windows-amd64.exe

   • macOS: openroads-darwin-amd64

Option B: Build from source

1. Clone the repository:

   git clone https://gitlab.phospher.com/darkhorse7881/openroads.git

2. Navigate to the project directory:

   cd openroads

3. Build the project:

   go build

2. Install in Synchronet

1. Copy the openRoads binary to your Synchronet external programs directory:

   cp openroads /path/to/sbbs/xtrn/

2. Make the binary executable (Linux/macOS only):

   chmod +x /path/to/sbbs/xtrn/openroads

3. Configure Synchronet to recognize openRoads:

   • Open the Synchronet Control Panel (SCFG)

   • Navigate to "External Programs" → "Online Programs (Doors)"

   • Add a new entry for openRoads

   • Set the command line to /path/to/sbbs/xtrn/openroads

3. Configuration

1. Create a configuration file at config/config.ini with your desired settings

2. Customize the world files in the world/ directory as needed

4. Testing the Installation

1. Start the openRoads server:

   ./openroads

2. Connect to the game:

   ?rlogin 127.0.0.1:2025 -q -c

3. Verify that you can log in and interact with the game world

Troubleshooting

• Connection refused: Ensure the server is running and listening on port 2025

• Missing world files: Check that the world/ directory contains the required JSON files

• Permission denied: Verify that the binary has execute permissions