35 lines
633 B
Markdown
35 lines
633 B
Markdown
# mudlib
|
|
|
|
a telnet MUD engine
|
|
|
|
built on telnetlib3, python 3.12+, managed with uv.
|
|
|
|
## Quickstart
|
|
|
|
```
|
|
uv sync
|
|
just run
|
|
```
|
|
|
|
then connect: `telnet localhost 6789`
|
|
|
|
## Commands
|
|
|
|
```
|
|
just check # lint + typecheck + test
|
|
just run # start the server
|
|
just debug # start with debug logging
|
|
just render # generate world map HTML
|
|
```
|
|
|
|
## What's in here
|
|
|
|
- `src/mudlib/` — the engine (commands, world, combat, rendering, storage)
|
|
- `tests/` — pytest tests
|
|
- `worlds/` — world definitions (yaml/toml)
|
|
- `docs/` — internal knowledge base
|
|
- `DREAMBOOK.md` — vision and wild ideas
|
|
|
|
## License
|
|
|
|
https://anticapitalist.software/
|