install.txt

Summary

See also the "install" file structure page.

Installation configuration files for ghost, balloon, shell, etc./SSP content archives (e.g., .nar, etc.). All archives can be unzipped and installed manually, but the presence of a properly configured install.txt file enables the installer function and allows installation by simple means such as drag and drop of the archive.

Sample descriptions and basic writing style

For a ghost Ghost (Balloons and Plugins are almost the same, just change the TYPE part)

charset,UTF-8
name,Mr. Example
type,ghost
directory,example

For additional shells

charset,UTF-8
name,Mr. Example Ultimate Form
type,shell
directory,ultimate
accept,Mr. Example

For ghost supplements (additional files)

charset,UTF-8
name,Mr. Example's Catification Patch
type,supplement
accept,Mr. Example

If you wish to include a balloon with your ghost

charset,UTF-8
name,Mr. Example
type,ghost
directory,example
balloon.directory,example_balloon
balloon.source.directory,balloon

※SSP only: Top-level item in case of multiple installation packages
(install.txt placed in each bundled package can be written as usual)

charset,UTF-8
name,Mr. Example Family Bulk Package
type,package

The charset must be specified in the first line (may be omitted in the case of Shift_JIS)

name and type are required. directory is also required if type is something other than supplement or package.
Other items should be specified as necessary.

In the case of additional shells or supplements, the "accept" specification can be used to avoid installation on unexpected ghosts.
In particular, it is almost essential in supplements due to the risk of unexpected file overwriting and damage.
Note that the specification uses the name of the main side, not the ghost name.

In SSP, if you want to bundle a balloon or plugin with a ghost or shell, use *.directory.

Note that the name is mainly used for the notification content in the Reference of the installation-related SHIORI Events.
Some ghosts may have a function that uses this information to switch to the target immediately after installation, but if the actual ghost name in descript.txt differs from the name in install.txt, the switch will not work properly. Take caution.

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,(object name)

Name of the object.

Cannot be omitted

type,(type)

Type of archive content. The types are as follows.

ghost: Ghost
shell: Additional shells a ghost
supplement: Additional files for a ghost
balloon: Balloon
plugin: Plugin
headline: Headline sensor
language: (SSP only) Language pack
calendar skin: (SSP only) Calendar appearance file
calendar plugin: (SSP only) Calendar schedule sensors
package: (SSP only) Package for multiple installations

[Old specification] (SSP only) If only "calendar" is written, it is treated as equivalent to "calendar skin".
This is a compatibility specification from a time when there was no calendar plugin, and should not be written now.

Cannot be omitted

accept,(main side name)

The name of the main side that can receive the archive (=\0 name, sakura name).
Or, the name set in install.accept install.accept in the ghost's descript.txt file is also acceptable.
This name must be used in content to be passed to a specific ghost, such as additional shells and additional files (supplement).

No behavior

directory,(directory name)

The name of the directory after the archive is installed. Half-width alphanumeric characters are recommended.

Cannot be omitted/Not required only for type,package.

refresh,(number)

If the number is set to 1, all files in the same directory are erased before installation.

Any value other than 1 (refresh disabled)

refreshundeletemask,(file name 1):(file name 2)...

Name of the file to be excluded from refresh erasure.
If there is more than one, separate them with a colon ":".
Path cannot be specified. Files with the specified filename in all directories are excluded.

No behavior

*.directory,(directory name)

Post-installation directory name of the content to be installed at the same time. Half-width alphanumeric characters are recommended.
The * portion contains the type (balloon, headline, plugin, calendar.skin, or calendar.plugin) of the content to be installed at the same time.
If you want to install multiple items of the same type, you can write the * part with a number after the type, such as balloon0, balloon1...
Can only be set if type is ghost or shell.

No behavior

*.source.directory,(directory name)

Directory name in the archive of the contents to be installed at the same time. Half-width alphanumeric characters are recommended.
Set this if the directory name after installation and the directory name in the archive do not match for the content to be installed at the same time.

Directory name set in *.directory

*.refresh,(number)

refresh settings for content to be installed at the same time.

Any value other than 1 (refresh disabled)

*.refreshundeletemask,(file name 1):(file name 2)...

refreshundeletemask settings of the content to be installed at the same time.

No behavior

delete.txt

Summary

See also the "network update" file structure page.

The client (user) file is only overwritten by the server (author) file when updated, not synchronized.
In other words, once a file is downloaded or created on the client side, it cannot be removed, even if it is deleted on the server side.
Therefore, if a file needs to be deleted once it has been published, it must be listed in delete.txt.
Note that delete.txt is not automatically deleted even after the deletion is executed, and once the content is added, it will remain permanently excluded unless it is changed.

The following specifications are for SSP only.

charset,(character code): Specify the character encoding of the file

Sample description

ghost\master\ai.dtx
ghost\master\testdict\
shell\master\surface110.png

(Relative path)

List the files to be deleted during network updates by path relative to the ghost's home folder.
Relative path hierarchy is delimited by "\".
It is also possible to specify an entire folder, in which case end with \.

No behavior

developer_options.txt

Summary

This is used to set options for the target file when SSP creates an archive or network update information file.
SSP has a function to create archives (.nar) and update files (updates2.dau) by dragging and dropping package folders such as Ghosts, and these are referenced when the function is executed.
Therefore, in principle, if you create these files using other tools such as "Sodate" or "Ghost Distribution Automated System", it is completely irrelevant, so be careful.
As an exception, there are some applications like "Satolist" that have a function that reads and uses developer_options.txt.

Sample description

ghost/master/savedata.txt,noupdate
shell/old/,nonar
ghost/master/profile/,nonar,noupdate

Important point

Please note that settings should be made on a single line for a single target (file or folder). For example, the following description will only apply the second setting (the one below) and will disable the nonar option.

ghost/master/profile/,nonar
ghost/master/profile/,noupdate

When two options are specified, the correct way is as described above.

ghost/master/profile/,nonar,noupdate

Like so.

(Relative path),(option 1),(option 2),...

Specify comma-separated options for files/folders, indicated by relative paths from the ghost's home folder.
Relative path hierarchies are separated by a "/", not a "\".
When specifying a folder, add / at the end.
* and ? can be used as wildcards (since SSP 2.5.17).
The options are as follows.

nonar: Do not include the target in nar when creating nar.
noupdate: Do not include the target as an update target when creating updates2.dau (updates.txt).

Note that these are controls when creating files, so they are only effective when creating nar or update files using SSP or the function of an application that can recognize this file.

No behavior

Subjects automatically excluded

When SSP creates nar/updates2.dau, the following files and folders are automatically excluded from the target even if developer_options.txt is not specified.

Files

desktop.ini
thumbs.db
folder.htt
mscreate.dir
.DS_Store
_CATALOG.VIX

Folders

profile/
var/
__MACOSX/
XtraStuf.mac/

updates_def.txt

[Old specification], currently specified in developer_options.txt.

(Relative path),ignore

Specify comma-separated options for files, indicated by relative paths from the ghost's home folder.
Cannot be specified per folder.
If the ignore option is present, the target is not included in the update information when creating updates2.dau (updates.txt).

No behavior

Install/Update settings

Install/Update

install.txt

delete.txt

developer_options.txt

updates_def.txt

Translated Document

install.txt

install.txt

Summary

Sample descriptions and basic writing style

delete.txt

delete.txt

Summary

Sample description

developer_options.txt

developer_options.txt

Summary

Sample description

Important point

Subjects automatically excluded

updates_def.txt