OpenRef is an open-source project that makes the BYOND DM Reference easier to maintain, improve, and expand through community contributions.
Originally started as a way to edit and version-control the reference, the project evolved into a document-processing pipeline featuring HTML parsing, structured document models, automated transformations, testing, CI/CD, and community tooling.
- HTML → structured document parsing
- Markdown generation and transformation
- Automated reference processing tools
- Test suite and CI/CD pipeline
- Discord bot integration
A community-maintained version of the DM Reference derived from BYOND's published documentation.
Contributions are welcome, including:
- Documentation ammendments
- Additional explanations and examples
- Tooling improvements
- Bug fixes
- Test coverage improvements
All changes should be submitted through a Pull Request and are subject to review before being merged. Discussion is available through GitHub or the BYONDiscord community: https://discord.gg/pTFccGgnAr
The reference is based on the web reference for BYOND version 516.1681.
Release notes: https://www.byond.com/docs/notes/516.html
This project demonstrates:
- Parser development
- Document transformation pipelines
- Python application architecture
- Automated testing
- CI/CD workflows
- Open-source collaboration