Development FAQ
Frequently asked questions for developers.
These answers may help when you're not sure how to handle bug reports you've received.
However, they don't cover information specific to each ghost's SHIORI, so see the explanations for each SHIORI in the Development links.
Questions about development basics
Q: I want to make a ghost! Where should I start?
A1: Once you have a general idea of what kind of ghost you want to make, you will probably start by preparing two things.
One is a shell, or a set of character images. You can either draw them yourself or ask someone else to draw them (as you might expect).
If you want to prepare them yourself, see the section on creating shells in “ukadoc,” listed in the Development links.
Otherwise, fortunately, there are shells called “free shells” that are available for anyone to use.
The “freeshell wiki” in the Development links should help you find free shells.
The other thing you need besides a shell is the core of the ghost, called SHIORI.
The way you build the ghost's brain—how it talks and acts in different situations—varies greatly depending on the SHIORI you use.
The Development links describe some of the most common SHIORI implementations.
Use that as a reference and choose one that suits you and your ghost.
Once you have both a shell and SHIORI, you're ready to start creating your ghost. From this point on, the work depends almost entirely on the SHIORI you chose.
So it may be a good idea to start by reading a site that explains your SHIORI in detail.
We've listed as many of those sites as possible in the Development links.
Q: How do I publish my ghost?
A1: If you don't need to add a network update feature to your ghost, it's easy.
All you need to do is package all your ghost's files into a nar (or zip) archive and publish it.
You may be able to use an online storage service (Dropbox, Google Drive, OneDrive, etc.) or a suitable file uploader.
You will need to prepare a few settings and files for this. For details, read the “Creating files for distribution” page in “ukadoc,” listed in the Development links.
However, if you plan to add a network update feature, you'll also need to prepare a server.
A server doesn't have to be anything special. You can use a service normally used to host a personal website, such as a rental server, rental space, or website publishing service.
However, depending on the server settings and terms of use, it may not be suitable for publishing a ghost.
You can look into what kinds of servers other ghost authors use, or read the “If you want to distribute a ghost” article in the Development links.
Once you have a server, all you need to do is upload your ghost's files to it.
As with a regular website, you can upload files using FTP.
For details, read the “Supporting network updates” page in “ukadoc,” listed in the Development links.
※If you aren't sure how to upload files to a server using FTP, try searching for “publish a website.”
In addition to general FTP software, you can also install the “Ghost Distribution Automation System” distributed by “Seibihan,” listed in the Development links. This can help you avoid some of the work and problems involved in uploading your ghost.
The initial installation and setup take a little effort, but please give it a try.
Q: Can I distribute SSP bundled with a ghost?
A1: This isn't prohibited, but we don't recommend it because it can cause many technical problems.
Q: How can I promote the content I've created?
Q: Where can I find the official SSP reference?
A1: It's “UKADOC,” at the top of the Development links.
Q: I've looked into various things about creating content, but still can't find the answer. Is there somewhere I can ask for help?
A1: The development forum at “Ukateki Forum,” listed in the Links, is a place for that.
Even if it looks like nobody is around, if you ask a question, someone will probably show up from somewhere.
As of 2015, Twitter is where the most people are. If you have an account, try posting your question with the “#伺か” or “#ukagaka” tag. Someone will almost certainly see it (and sometimes you'll get surrounded by enthusiastic helpers, so please don't be scared off).
Questions about bugs
Q: I see a lot of entries in the error log. Is it okay to ignore them?
A1: It depends. For details, see the Script log page.
Q: I get an MD5 mismatch error, and network updates aren't working.
A1: Did you modify any files targeted for updating after creating the update files (update.txt/update2.dau)?
Also, when uploading the update files over FTP, did you transfer them in ASCII mode?
To help prevent these kinds of mistakes, you can use the “Ghost Distribution Automation System,” distributed by “Seibihan” and listed in the Links.
A2: Depending on the server settings, uploaded files may have been modified.
For example, some free website hosting services occasionally try to forcibly insert advertisements even into text files.