cxmeel / dump-parser

Parses data from the Roblox API dump

Dump Parser

A generic parser for the Roblox API dump. Inspired by @corecii's API Dump (Static) and @raphtalia's RobloxAPI libraries.

Documentation

Documentation can be found at https://csqrl.github.io/dump-parser.

Quick Start

Dump Parser is available via Wally.

Wally

# wally.toml

[dependencies]
DumpParser = "csqrl/[email protected]"

$ wally install

Manual Installation

Download a copy of the latest release from the GitHub repo, and compile it using Rojo. From there, you can drop the binary directly into your project files or Roblox Studio.

Example Usage

local DumpParser = require(path.to.DumpParser)
local Dump = DumpParser.fetchFromServer()

local PartClass = Dump:GetClass("Part")

-- Get a list of all properties on "Part"
print(PartClass:GetProperties())

--[[
	Get a list of safe-to-use properties on "Part". This is
	functionally equivalent to:

	```lua
	PartClass:GetProperties(
		Filter.Invert(Filter.Deprecated), -- Include non-deprecated
		Filter.HasSecurity("None"), -- Include properties with no read/write security
		Filter.Scriptable -- Include properties that can be set in scripts
	)
	```

	`GetProperties`, `GetEvents`, `GetFunctions` and `GetCallbacks`
	all accept a variable number of filters as arguments. This
	allows you to filter down the list of results to only what
	you need.
--]]
print(Dump:GetProperties("Part"))