From 71a6ab33ad1cb4e7c5b3e33ec694a7dfd5374c87 Mon Sep 17 00:00:00 2001 From: rhunk <101876869+rhunk@users.noreply.github.com> Date: Mon, 25 Dec 2023 02:07:59 +0100 Subject: [PATCH] chore: displayName --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b78867..9e77b4d 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,20 @@ In case of any questions, feel free to ask via opening an issue or asking on our Every script written for the Scripting Engine must include a header section at the beginning of the file. The header follows a specific format, as shown below: ``` // ==SE_module== -// name: Script Name +// name: script_name +// displayName: Script Name // description: Script description // version: 1.0 // author: Author // ==/SE_module== ``` -The following fields are required: `name`, `version`
-Additionally, there are also optional fields available which are: `description`, `author`, `minSnapchatVersion`, `minSEVersion`, `grantedPermissions` +The following fields are required: `name`, `version`, `author`
+Additionally, there are also optional fields available which are: `displayName`, `description`, `minSnapchatVersion`, `minSEVersion`, `grantedPermissions` ### Field Description -`name`: Descriptive name for the script.
+`name`: Descriptive name for the script. Must be composed of lowercase letters and underscores only.
+`displayName`: Display name of the script.
`author`: Name of the script's creator.
`version`: Version number of the script (e.g., 1.0).
`description`: Brief explanation of the script's functionality.