https://github.com/chadhyatt/LuaEncode
Table Serialization Library for Pure Luau/Lua 5.1+
https://github.com/chadhyatt/LuaEncode
lua luau roblox serialization
Last synced: about 2 months ago
JSON representation
Table Serialization Library for Pure Luau/Lua 5.1+
- Host: GitHub
- URL: https://github.com/chadhyatt/LuaEncode
- Owner: regginator
- License: mit
- Created: 2022-11-06T19:08:23.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-26T04:49:59.000Z (11 months ago)
- Last Synced: 2024-11-26T05:18:57.110Z (11 months ago)
- Topics: lua, luau, roblox, serialization
- Language: Lua
- Homepage: https://latte.to
- Size: 169 KB
- Stars: 29
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[latest-release]: https://github.com/chadhyatt/LuaEncode/releases/latest
[license]: https://github.com/chadhyatt/LuaEncode/blob/master/LICENSE.txt
[commits]: https://github.com/chadhyatt/LuaEncode/commits
[wally]: https://wally.run/package/chadhyatt/luaencode
[roblox-marketplace]: https://create.roblox.com/marketplace/asset/12791121865/LuaEncode
[badges/latest-release]: https://img.shields.io/github/v/release/chadhyatt/LuaEncode?label=Latest%20Release
[badges/last-modified]: https://img.shields.io/github/last-commit/chadhyatt/LuaEncode?label=Last%20Modifed
[badges/license]: https://img.shields.io/github/license/chadhyatt/LuaEncode?label=License
[badges/wally]: https://img.shields.io/badge/wally.run-chadhyatt%2Fluaencode-%23ad4646?style=flat"
[social/roblox-marketplace]: gh-assets/roblox-marketplace-icon.svg
# LuaEncode
Fast table serialization library for pure Luau/Lua 5.1+
[![Latest Release][badges/latest-release]][latest-release] [![Last Modified][badges/last-modified]][commits] [![License][badges/license]][license] [![Wally][badges/wally]][wally]
[![Roblox Marketplace][social/roblox-marketplace]][roblox-marketplace]
___
## 🎉 About
LuaEncode is a simple library for serialization of Lua tables and basic data types, along with support for all of Roblox's engine data types. LuaEncode supports both Luau and Lua 5.1+
### 🌟 Features
* Serialization and output of basic types `number`, `string`, `table`, `boolean`, and `nil` for key/values
* Pretty-printing and custom indentation configuration
* Compatible with Roblox's engine data types (`Instance`, `UDim2`, `Vector3`, `DateTime`, etc..) - See **[Roblox Engine Data Type Coverage](#roblox-engine-data-type-coverage)** for more info
* Secure table iteration and value reading, with potentially untrusted inputs in-mind
* Manual cycle inserts in serialized codegen with [`InsertCycles`](#api)
* Extended raw key/value inserts with [`FunctionsReturnRaw`](#api)
___
## ⚙️ Installation
* ### Rojo/Wally
If you're using [Rojo](https://rojo.space) and [Wally](https://wally.run/), you can import the package in your `wally.toml`:
```toml
LuaEncode = "chadhyatt/luaencode@1.4.4"
```
* ### Roblox Marketplace
You can also grab the LuaEncode module from the Roblox Marketplace:
___
## 🚀 Basic Usage
```lua
local LuaEncode = require("path/to/LuaEncode")
local Table = {
foo = "bar",
baz = {
1,
2,
3,
[5] = 5,
},
qux = function()
return "\"hi!\"" -- With `FunctionsReturnRaw` set as true in options, this will output as 'qux = "hi!"'
end,
}
local Encoded = LuaEncode(Table, {
Prettify = true,
FunctionsReturnRaw = true,
})
print(Encoded)
```
Output
```lua
{
qux = "hi!",
baz = {
1,
2,
3,
[5] = 5
},
foo = "bar"
}
```
___
## 🔨 API
```lua
LuaEncode(inputTable: {[any]: any}, options: {[string]: any}): string
```
### Options
| Argument | Type | Description |
|:-------------------|:--------------------|:------------------------------------|
| Prettify | `` | Whether or not the output should be [pretty printed](https://en.wikipedia.org/wiki/Prettyprint#Programming_code_formatting) |
| IndentCount | `` | The amount of characters that should be used for indents (**Note**: If `Prettify` is set to true and this is unspecified, it will default to `4`) |
| InsertCycles | `` | If there are cyclic references in your table, the output will be wrapped in an anonymous function that manually sets paths to those references. (**NOTE:** If a key in the index path to the cycle is a reference type (e.g. `table`, `function`), the codegen can't externally set that path, and the value will have to be ignored) |
| OutputWarnings | `` | If "warnings" should be placed into the output as comment blocks |
| FunctionsReturnRaw | `` | If `function` values should be treated as callbacks that return a string to be inserted directly into the serialized output as the key/value |
| UseInstancePaths | `` | If Roblox `Instance` values should return their Lua-accessable path for serialization. If the instance is parented under `nil` or isn't under `game`/`workspace`, it'll always fall back to `Instance.new(ClassName)` |
| UseFindFirstChild | `` | When `options.UseInstancePaths` is true, whether or not instance paths should use `FindFirstChild` instead of direct indexes |
| SerializeMathHuge | ` ` | If "infinite" (or negative-infinite) numbers should be serialized as `math.huge`. (uses the `math` global, as opposed to just a direct data type) If false, "`1/0`" or "`-1/0`" will be serialized, which is supported on all target Lua environments |
___
## Roblox Engine Data Type Coverage
*(See [AllRobloxTypes.server.lua](tests/RobloxTests/AllRobloxTypes.server.lua) for example input and output of supported Roblox data types.)*
✔ Implemented | ➖ Partially Implemented | ❌ Unimplemented | ⛔ Never
| DataType | Serialized As | Implemented |
|:--------------------------------------------------------------------------------------------------------------|:--------------------------------------------------|:-----------:|
| [buffer](https://create.roblox.com/docs/reference/engine/libraries/buffer) | `buffer.fromstring()` | ✔ |
| [SharedTable](https://create.roblox.com/docs/reference/engine/libraries/SharedTable) | `SharedTable.new()` | ✔ |
| [Axes](https://create.roblox.com/docs/reference/engine/datatypes/Axes) | `Axes.new()` | ✔ |
| [BrickColor](https://create.roblox.com/docs/reference/engine/datatypes/BrickColor) | `BrickColor.new()` | ✔ |
| [CFrame](https://create.roblox.com/docs/reference/engine/datatypes/CFrame) | `CFrame.new()` | ✔ |
| [CatalogSearchParams](https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams) | `CatalogSearchParams.new()` | ✔ |
| [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | `Color3.new()` | ✔ |
| [ColorSequence](https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence) | `ColorSequence.new()` | ✔ |
| [ColorSequenceKeypoint](https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint) | `ColorSequenceKeypoint.new()` | ✔ |
| [DateTime](https://create.roblox.com/docs/reference/engine/datatypes/DateTime) | `DateTime.fromUnixTimestamp()` | ✔ |
| [DockWidgetPluginGuiInfo](https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo) | `DockWidgetPluginGuiInfo.new()` | ✔ |
| [Enum](https://create.roblox.com/docs/reference/engine/datatypes/Enum) | `Enum.` | ✔ |
| [EnumItem](https://create.roblox.com/docs/reference/engine/datatypes/EnumItem) | `Enum..` | ✔ |
| [Enums](https://create.roblox.com/docs/reference/engine/datatypes/Enums) | `Enum` | ✔ |
| [Faces](https://create.roblox.com/docs/reference/engine/datatypes/Faces) | `Faces.new()` | ✔ |
| [FloatCurveKey](https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey) | `FloatCurveKey.new()` | ✔ |
| [Font](https://create.roblox.com/docs/reference/engine/datatypes/Font) | `Font.new()` | ✔ |
| [Instance](https://create.roblox.com/docs/reference/engine/datatypes/Instance) | `Instance.new()` | ✔ |
| [NumberRange](https://create.roblox.com/docs/reference/engine/datatypes/NumberRange) | `NumberRange.new()` | ✔ |
| [NumberSequence](https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence) | `NumberSequence.new()` | ✔ |
| [NumberSequenceKeypoint](https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint) | `NumberSequenceKeypoint.new()` | ✔ |
| [OverlapParams](https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams) | `OverlapParams.new()` | ✔ |
| [Path2DControlPoint](https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint) | `Path2DControlPoint.new()` | ✔ |
| [PathWaypoint](https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint) | `PathWaypoint.new()` | ✔ |
| [PhysicalProperties](https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties) | `PhysicalProperties.new()` | ✔ |
| [RBXScriptConnection](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection) | `N/A` | ⛔ |
| [RBXScriptSignal](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal) | `N/A` | ⛔ |
| [Random](https://create.roblox.com/docs/reference/engine/datatypes/Random) | `Random.new()` | ✔ |
| [Ray](https://create.roblox.com/docs/reference/engine/datatypes/Ray#summary-constructors) | `Ray.new()` | ✔ |
| [RaycastParams](https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams) | `RaycastParams.new()` | ✔ |
| [RaycastResult](https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult) | `N/A` | ⛔ |
| [Rect](https://create.roblox.com/docs/reference/engine/datatypes/Rect#summary-constructors) | `Rect.new()` | ✔ |
| [Region3](https://create.roblox.com/docs/reference/engine/datatypes/Region3) | `Region3.new()` | ✔ |
| [Region3int16](https://create.roblox.com/docs/reference/engine/datatypes/Region3int16) | `Region3int16.new()` | ✔ |
| [TweenInfo](https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo) | `TweenInfo.new()` | ✔ |
| [RotationCurveKey](https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey) | `RotationCurveKey.new()` | ✔ |
| [Secret](https://create.roblox.com/docs/reference/engine/datatypes/Secret) | `N/A` | ⛔ |
| [UDim](https://create.roblox.com/docs/reference/engine/datatypes/UDim) | `UDim.new()` | ✔ |
| [UDim2](https://create.roblox.com/docs/reference/engine/datatypes/UDim2) | `UDim2.new()` | ✔ |
| [Vector2](https://create.roblox.com/docs/reference/engine/datatypes/Vector2) | `Vector2.new()` | ✔ |
| [Vector2int16](https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16) | `Vector2int16.new()` | ✔ |
| [Vector3](https://create.roblox.com/docs/reference/engine/datatypes/Vector3) | `Vector3.new()` | ✔ |
| [Vector3int16](https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16) | `Vector3int16.new()` | ✔ |
*(See official Roblox data type documentation [here](https://create.roblox.com/docs/reference/engine/datatypes))*
___
## 🏛️ License
```
MIT License
Copyright (c) 2022-2025 Chad Hyatt
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```