#documentation #manual #studio #collection #parser #page #typings

bin+lib gm-docs-parser

A collection of typings for GameMaker Studio 2 manual pages

1 stable release

1.0.0 Aug 3, 2020

#5 in #typings

MIT/Apache

1MB
847 lines

Gm-Docs Parser

This is a parser for Gms2.3 documentation. Each version of this crate can only parse a given version of Gms2 docs, as scraping is required to do so.

Please use this responsibly, and also, if you're Yyg, please stop reading and pretend like you didn't see this.

This crate is dual licensed. Feel free to use it as either MIT or Apache.


lib.rs:

These are typings for the Gms2 Manual Documentation, which is provided by the executable made by this crate. That executable is not published on crates.io, but is at the projects Github page, where users can get the exe in the releases page.

The purpose of these typings are for downstream consumers of the Manual, who will create their database offline and load those typings using Serde. These typings do not assume that users will create them at all, but they are made entirely public for simplicity. Therefore, this library makes guarentees which the type system does not and could not support, as the guarentees this documentation makes are held up by invariants in the exe which creates the Json, rather than the type system itself.

Dependencies

~7–17MB
~240K SLoC