Skip to content

README.md

Latest commit

 

History

History
50 lines (31 loc) · 1.75 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.75 KB
Raw

Neolith Examples

This directory contains example MUD server applications, a minimal example mudlib, and Python integration testbots for the Neolith LPMud driver.

Example Types

apps/ — MUD Applications

Single-file LPC programs passed directly to the driver. Use these to quickly try out driver features or prototype new functionality without setting up a full mudlib.

/path/to/neolith -c apps/hello_world.c

m3_mudlib/ — Example Mudlib

A minimal LPC mudlib that boots the driver and supports interactive or scripted sessions. It is also the backing mudlib for Neolith's integration tests.

/path/to/neolith -f m3.conf -c

m3_testbots/ — Integration Testbots

Python scripts that run the driver as a subprocess in console mode and validate end-to-end behavior by sending commands through piped stdin/stdout.

hatch run smoke_test

Requires a one-time hatch setup — see m3_testbots/README.md for details.

Configuration

m3.conf sits alongside m3_mudlib/ in this directory. Its MudlibDir is the relative path m3_mudlib, which Neolith resolves relative to the conf file's own location. This keeps the whole examples/ tree relocatable — no absolute paths needed. (MudOS required MudlibDir to be absolute.)

Copy to m3.local.conf for local customization:

cp m3.conf m3.local.conf

Note

The m3.conf disables telnet port by default to accelerate Neolith unit-testing and allows multiple instances of MUD applications. You can enable the telnet port by uncommenting the Port line.

Further Reading