Translated Document
- This document has been translated from the original Japanese by members of the Ukagaka Dream Team community.
- To see the original document, click here.
- To submit corrections/updates, see our repository to open an issue or find where to contact us.
See PLUGIN/2.0 for overall plugin specifications.
descript.txt
descript.txt (of Plugin)
Summary
Basic plugin configuration file.
Sample description and basic writing style.
charset,UTF-8
name,Dummy Plugin
id,21AC84B0-6B1F-11E4-9803-0800200C9A66
filename,rei.dll
name, id, and filename are required.
Note that strings beginning with \ or % are considered tags in Sakura Script or environment variables, and are discarded due to security risks. If you want to include them as just characters, you need to escape them as \\ or \%.
- charset,(character code)
-
Character code to be used. Shift_JIS is recommended for compatibility with older environments, otherwise UTF-8 is recommended.
(OS default setting or SSP -> Internationalization -> Default charset -> Text definition)
- name,(plugin name)
-
Name of the plugin.
Cannot be omitted
- id,ID
-
A string of characters that will be the ID of the plugin, with as little chance of being duplicated as possible.
Strings must be up to 63 bytes and consist only of single byte characters. Usually what is called GUID/UUID is used.
Once it is decided, it must not be changed.
Matching IDs indicate that the plugins are compatible, even if they have different names.
※Generation with http://www.famkruithof.net/uuid/uuidgen.
Alternatively, if you have a reasonable development environment, you can use the Registry Format of guidgen.exe.
Tools are also distributed.Cannot be omitted
- filename,dll
-
Path of the dll that makes up the plugin.
Cannot be omitted
- type,(type)
-
Fileset type. For plugins, "plugin".
No value
- craftman,(author name)
-
The name of the author of the plugin. Alphanumeric characters only.
No value
- craftmanw,(author name)
-
The name of the author of the plugin.
No value
- craftmanurl,URL
-
Author's URL.
No value
- homeurl,URL
-
Network update URL.
No value
- readme,(filename)
-
The name of the plugin explanation text file that is opened during installation.
readme.txt
- readme.charset,(character code)
-
Character code of the explanation text file.
(OS default setting or SSP → Internationalization → Default charset → readme)
2.5.10
- secondchangeinterval,(number of seconds)
-
Inverval (in seconds) at which PLUGIN Event OnSecondChange is notified.
0 to disable.1
- otherghosttalk,(option)
-
Setting for notifying PLUGIN Event OnOtherGhostTalk.
- false
- No notification
- 0
- No notification
- true
- Immediate notification (immediately after speaking is finished)
- 1
- Immediate notification
- after
- Immediate notification
- before
- Pre-nofification (notification just before speaking starts)
false