Install

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 the "Creating files for distribution" page for information on how to create an archive itself for distribution.

Ghosts are generally distributed in archives with the extension nar (Nanika ARchive).

nar is just a different extension on a zip, but the entity is a zip, so some servers may distribute it as zip.

Although it is possible to install lzh with a decompression DLL, it should not be used unless there is a good reason to do so.

SSP can install cab or self-extracting exe as well.

The archive can be unzipped and installed manually, but if the install.txt file is properly prepated, the installer function can work and install files automatically when they are dragged and dropped, or other such means.

nar can be created by dragging and dropping a ghost folder containing install.txt to the baseware (SSP) itself.

It is equivalent to manually zipping and renaming, but be careful not to make the file hierarchy too deep.

When distributing ghosts, be careful not to include the profile folder in the ghsot and shell folders, save data, etc.

The same can be said for network updates.

SSP provides developer_options.txt to control this.

For a standard ghost
+-(myghost)
  +-ghost
  +-shell
  +-install.txt
  +-developer_options.txt (SSP only)
  +-readme.txt
  +-thumbnail.png
  :
  :

In the case of supplement, the folder structure of the above contents will be left as is, with only the files to be added included.

For example, if you want to add the file dic_supplement.txt to ghost/master/ it will be structured like so:

+-(mysupplement)
  +-install.txt
  +-developer_options.txt (SSP only)
  +-ghost
    +-master
      +-dic_supplement.txt
For standard additional shells
+-(additional_shell)
  +-install.txt
  +-developer_options.txt (SSP only)
  +-descript.txt
  +-readme.txt
  +-thumbnail.png
  +-surface*.png
  +-surfaces.txt
  :
  :
For standard balloons
+-(myballoon)
  +-install.txt
  +-developer_options.txt (SSP only)
  +-descript.txt
  +-balloonc*.png
  +-balloons*.png
  +-balloonk*.png
  :
  :
If you wish to include balloons or other items with the ghost
+-(myghost)
  +-install.txt
  +-developer_options.txt (SSP only)
  +-ghost
  +-shell
  +-(myballoon)
    +-descript.txt
    +-balloons0.png
    :
    :

The same applies to plugins, etc. (If you want to include a shell in the package, just put it under the shell folder normally instead of doing this).

Also, the item to be included (the balloon in the above example) does not need install.txt. Even if it exists, it will be ignored.

(SSP only) Package for multiple installations
+-(mypackage)
  +-install.txt (For package)
  +-(myghost1)
    +-install.txt (For myghost1)
    +-developer_options.txt (SSP only)
    +-ghost
    +-shell
    :
  +-(myghost2)
    +-install.txt (For myghost2)
    +-developer_options.txt (SSP only)
    +-ghost
    +-shell
    :

Note that a separate install.txt file is required for the package and for the individual items.

Any item that can be included in a stand-alone archive, not just Ghost, can be included. But be careful not to mix different objects if there is a specific target, such as with shell or supplement.

Others, such as headline sensors, stand-alone plugin distribution, etc., should similarly place install.txt at the top of their directory.
install.txt

Text describing installation settings.

Without this file, the automatic installation function via dragging and dropping or other methods will not work.

Set the archive content type, archive name, directory name, etc.

See link for details.

developer_options.txt

SSP only. May be omitted.

Place it in the same location as install.txt.

Note, however, that in the case of a package for multiple installations, it should be placed in the location where the install.txt of each item is located, not the top-level install.txt.

A file for setting which files should be excluded when creating nar with SSP.

See link for formatting and other details.