majjo/scripting-docs
1
0
Fork 0
mirror of https://github.com/SnapEnhance/scripting-docs.git synced 2026-08-31 12:42:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: displayName

Browse Source
This commit is contained in:
rhunk
2023-12-25 02:07:59 +01:00
committed by GitHub
parent 6a256aead0
commit 71a6ab33ad
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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: 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== // ==SE_module==
// name: Script Name // name: script_name
// displayName: Script Name
// description: Script description // description: Script description
// version: 1.0 // version: 1.0
// author: Author // author: Author
// ==/SE_module== // ==/SE_module==
``` ```
The following fields are required: `name`, `version`<br> The following fields are required: `name`, `version`, `author`<br>
Additionally, there are also optional fields available which are: `description`, `author`, `minSnapchatVersion`, `minSEVersion`, `grantedPermissions` Additionally, there are also optional fields available which are: `displayName`, `description`, `minSnapchatVersion`, `minSEVersion`, `grantedPermissions`
### Field Description ### Field Description
`name`: Descriptive name for the script.<br> `name`: Descriptive name for the script. Must be composed of lowercase letters and underscores only.<br>
`displayName`: Display name of the script. <br>
`author`: Name of the script's creator.<br> `author`: Name of the script's creator.<br>
`version`: Version number of the script (e.g., 1.0).<br> `version`: Version number of the script (e.g., 1.0).<br>
`description`: Brief explanation of the script's functionality.<br> `description`: Brief explanation of the script's functionality.<br>