https://github.com/cxmeel/dump-parser
Parses data from the Roblox API dump
https://github.com/cxmeel/dump-parser
api conversion data luau roblox roblox-api roblox-api-wrapper roblox-lua robloxdev robloxlua rojo utility wally
Last synced: 14 days ago
JSON representation
Parses data from the Roblox API dump
- Host: GitHub
- URL: https://github.com/cxmeel/dump-parser
- Owner: cxmeel
- License: mit
- Created: 2022-11-30T20:28:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T14:52:31.000Z (over 1 year ago)
- Last Synced: 2024-08-14T16:24:33.728Z (over 1 year ago)
- Topics: api, conversion, data, luau, roblox, roblox-api, roblox-api-wrapper, roblox-lua, robloxdev, robloxlua, rojo, utility, wally
- Language: Lua
- Homepage: https://csqrl.github.io/dump-parser/
- Size: 1.14 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Dump Parser
A generic parser for the Roblox API dump. Inspired by [@corecii](https://github.com/Corecii)'s
[API Dump (Static)](https://github.com/corecii/api-dump-static) and
[@raphtalia](https://github.com/raphtalia)'s [RobloxAPI](https://github.com/raphtalia/robloxapi)
libraries.
## Documentation
Documentation can be found at https://csqrl.github.io/dump-parser.
## Quick Start
Dump Parser is available via [Wally](https://wally.run).
### Wally
```toml
# wally.toml
[dependencies]
DumpParser = "csqrl/dump-parser@0.1.0"
```
```bash
$ 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
~~~lua
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"))
~~~