gm-docs-parser v1.3.0

gm-docs-parser

Parses the GameMaker Manual and turns the data into a usable JSON file containing every GML function.

Programmatic usage

Only ESM is supported.

import { parseDocs } from 'gm-docs-parser';

// Path to an existing folder where the GameMaker Manual will be cloned into
const workingDirectory = 'path/to/folder';

const result = await parseDocs(workingDirectory);

if (result.success) {
  // Record of GML functions
  console.log(result.docs);
} else {
  // Display failure reason
  console.error(result.reason);
}

CLI usage

# Install globally
> npm install gm-docs-parser -g

# Generate a docs.json file in CWD
> gm-docs-parser

# Generate a docs.json file without prettifying the output
> gm-docs-parser --ugly

# Generate a docs.json file and delete the cloned GameMaker manual afterwards
> gm-docs-parser --clean