From 16390456209e542d357573fea78ca29404403f64 Mon Sep 17 00:00:00 2001 From: Thomas Date: Sat, 15 Apr 2023 18:38:07 +0200 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee312bc..b828b0c 100644 --- a/README.md +++ b/README.md @@ -40,4 +40,31 @@ local script = [[ ]] screen.setRenderScript(script) -``` \ No newline at end of file +``` + +## Addition to the default render script + +This library add some functions to the default render script: + +### Third Party libraries support + +`use(libraryName)`: Use a third party library in the renderscript +- `libraryName`: `string` The name of the library to use, it will also be used as the variable name to access it in the renderScript + +`useAtlas()`: Use the atlas library in the renderscript + +`useJSON()`: Use the JSON (dkjson) library in the renderscript + +`useRSLib()`: Use the RSLib library in the renderscript + +### RenderScript utilities functions + +`getMaxSize()`: Get the maximum size of the render script + +`isTooLong()`: Check if the render script is too long + +`sendToScreen(screen)`: Send the render script to a screen + +### Others + +`insertCodeLine(code)`: Insert a line of code in the render script \ No newline at end of file -- 2.51.2