Skip to content

EricFecteau/dcss-api

Repository files navigation

dcss-api

This repo contains a series of libraries in Rust and Python to work with Dungeon Crawl Stone Soup's (DCSS) Webtile.

Crates

dcss-api is an easy to use Rust wrapper for DCSS Webtile websocket API. It works with version 0.29, 0.30, 0.31 or 0.32 of DCSS.

dcss-scenario-builder is a crate to build scenarios in DCSS (wizmode) from a yaml file by providing features, items and monsters and mapping them on a tile map. This is great for testing other crates in this repository.

dcss-api is an easy to use Python wrapper for DCSS Webtile websocket API, that includes the dcss-scenario-builder functionalities. It works with version 0.29, 0.30, 0.31 or 0.32 of DCSS.

dcss-data (experimental)

dcss-data is a Rust data model for the data received from DCSS Webtile (tiles, monsters, items, menus, etc.). It is currently experimental and the interface will break without notice.

Docs

Documentation about the DCSS websocket API can also be found here.

Server & testing

The Justfile has commands to setup a DCSS Webtile server, with the correct configurations. Run just setup-dcss-server to setup the server, just dcss-run to run the server and just dcss-create-users to create the required users for testing. For the server prerequisites and other options, see the DCSS Webtiles Server page. To build the python library, run just setup-python. Testing can be run with just test-api for Rust and just test-python for Python.

About

Rust and Python wrapper for Dungeon Crawl Stone Soup's (DCSS) Webtile websocket API

Resources

License

Stars

Watchers

Forks

Releases

No releases published