ONScripter page

Source package

• onscripter-20120128.tar.gz
• onscripter-20120115.tar.gz (Previous release)

Binary package (Android and Zaurus packages are tested by ME）

ONScripter-EN is an extended version of ONScripter developed by Uncle Mion san that handles English scripts in a better way. It supports more NScripter commands and it can handle ordinary Japanese scripts as well.

Features

1. It can load/save a save file compatible with the latest NScripter (2011/12/15). Please see How to share save files on different platforms for details.
2. Mouse operations can be performed by keyboard short-cuts.
3. Music files (MP3, Ogg) can be played instead of CD Audio tracks.
4. It has been reported that ONScripter runs on Windows, Linux, MacOS X, MacOS 9, Android(1.6 or later), iPhone, PSP, Zaurus (SL-5500,SL-A300,SL-B500,SL-C700), FreeBSD, Solaris(on SPARC), Tru64 UNIX, OS/2Warp, iPod, PocketPC, Playstation3, Wii, GP2X, NetWalker and Dreamcast. For other platforms where Requirements are satisfied, I'm sure it can be complied and run.
5. Not all the commands and specifications of NScripter are supported. If you find something wrong, please send a report to me.

Requirements

The required programming languages and libraries are listed below. The version number in the list are those of my environment, but you do not have to use the same version.

Required

• C++ programming language
  • g++ 4.4.4 (Linux)
  • Visual Studio 2008 C++ (Windows)
• Japanese TTF file based on Unicode renamed as "default.ttf"
• libjpeg-6b (Independent JPEG Group)
• bzip2-1.0.5 (bzip2)
• SDL-1.2.14, SDL_image-1.2.10, SDL_mixer-1.2.8, SDL_ttf-2.0.9, SMPEG-0.4.5 (Simple Directmedia Layer)
• FreeType 2.3.11 (the Free Type Project)

Recommended

• ogg-1.2.0, vorbis-1.3.1 (The Ogg Vorbis CODEC Project)
  It is required if you want to play Ogg vorbis music. It is enabled by default in Makefile.Linux and Makefile.ArmLinux included in the source package. Tremor vorbis can be used instead that decodes music using integer arithmetics only.

Not required

• mad-0.15.1b (MAD: Mpeg Audio Decoder)
  It is a MP3 decoding library using integer arithmetics only. If you want to play MP3 music on Android or Zaurus, it must be necessary. To use MAD, SDL_mixer library must be built with MAD enabled instead of SMPEG.
• avifile-0.7.48 (avifile)
  If you want to play AVI files using avi command, it is required. It is enabled when USE_AVIFILE is defined and AVIWrapper.o is linked.

ONScripter is tested on Windows, Linux, Android (HTC Desire (2.3)) before it is released.

Compilation

Unpack ONScripter package in an appropriate location. Then, type " make -f Makefile.Linux " on Linux, or type " nmake -f Makefile.Win " on Windows. Please note that the path to the header files and libraries for bzip2, SDL, SMPEG, etc., should be modified in Makefile depending on your environment.

Run

[Required] Copy the necessary archives of a game in the same location. Usually, you need a script file (0.txt or nscript.dat) and an archive file (arc.sar or arc.nsa). If there are other archive files such as arc1.nsa to arc9.nsa, you need to copy them. In some games, images and sounds are placed outside archive files. In that case, you also need to copy them to a directory of the same name. The simplest way is to copy all the files under the game directory.

[Required] Following Displaying Kanji using TrueType font, place a Japanese TrueType font file named "default.ttf"

[Optional] If you want to use sound files instead of CD audio tracks, follow Using sound files instead of CD audio and place sound files.

[Required] Run ONScripter. It reads from nscript.dat and archives in the same directory, and the game will start. Since ONScripter outputs save files and status files in the same directory, please be sure that the directory has write permission.

Keyboard shortcut

All operations including mouse operations can be performed by keyboard short-cuts, though the shortcut keys defined in the script have priority.

Command line options

How to share save files on different platforms

You can share save files among different platforms such as desktop PC (Windows, Linux), smartphone (Android), etc. To do this, you need to setup the archives of a game on all platforms and move all updated files generated by ONScripter (or NScripter) from one platform to another.

NScripter or ONScripter generates/updates following files. Some files may not be generated and be missing dependent on games.

The format of a save file may change when a new version of NScripter (or ONScripter) is released. So, ONScripter generates a save file with the version number of the save file in the beginning. Save files without version number are also generated under "sav" directory if it exists and they are compatible with the save files generated by the latest NScripter. Note that the version number of save files is different from that of ONScripter.

ONScripter can load both save files with version number and those in the latest format without version number.

Move from ONScripter to ONScripter

Simply copy all the above mentioned modified files including save*.dat.

ONScripter_dir/* → ONScripter_dir/*

Move from NScripter to ONScripter

Simply copy all the above mentioned modified files including save*.dat.

NScripter_dir/* → ONScripter_dir/*

Move from ONScripter to NScripter

Copy all the above mentioned modified files except for save*.dat.

ONScripter_dir/* -> NScripter_dir/*

Copy save files under "sav" directory

ONScripter_dir/sav/save*.dat -> NScripter_dir/save*.dat

Notice

• Save files generated by nscr.exe released in 2011/12/15 are supported as the latest format. Save files generated by the older version of NScripter are not supported.
• Compatibility is not guaranteed, though there has been no problem as far as I know.
• Because ONScripter cannot load save files generated by the older version of NScripter, please use the above mentioned latest NScripter from the beginning when you use both ONScripter and NScripter.
• To use both ONScripter and NScripter, please make "sav" directory in advance.

Reading from the registry

getreg obtains the specified data from the registry of Windows. ONScripter realizes this function by reading from a text file named "registry.txt" where the data is written.

The format of "registry.txt" is as follows. It is case sensitive. Please do not insert extra spaces. If you use Kanji characters, please be sure that it is written in Shift JIS.

[the second argument of getreg (excluding quotation marks around)]
the third argument of getreg = 比較対象文字列（前後の""は必要です）

An example of "registry.txt"

[software\StudioOGA\ONScripter]
"INSTALL"="FULL"

[software\StudioOGA\のまど]
"Download log file"="c:\nomad_down.log"
"Upload log file"="c:\nomad_up.log"

ONScripter 起動時に --registry オプションを指定することで、 registry.txt を一カ所にまとめておくことができます。--registry を指定し ない場合は、現在のディレクトリの registry.txt を読みにいきます。

Loading DLL

exec_dll コマンドは Windows 上で実行可能な DLL (Dynamic Link Library) を実行します。ONScripter では、テキストファイル dll.txt に DLL 名とその戻値の対応を記述し、これを読み込むことでこの機能を実現しま す。従って、実際に DLL が実行されるわけではなく、また戻値は固定になり ます。

dll.txt の書式は次の通りです。大文字・小文字は区別されます。また余 計なスペース等を入れないようにして下さい。漢字が使われている場合、文字 コードが Shift JIS になることに注意してください。

[dll 名]
str = "文字列(getret で受け取ることのできる文字列戻値))" 
ret = 整数(getret で受け取ることのできる数字戻値)

dll.txt の例

[test.dll]
str = "山田/太郎/やまだ/たろう"
ret = 1

[test2.dll]
str = "StudioOGA"
ret = 2

ONScripter 起動時に --dll オプションを指定することで、dll.txt を一 カ所にまとめておくことができます。--dll を指定しない場合は、現在のディ レクトリの dll.txt を読みにいきます。

Online modification of volume and variables

これは暫定的なおまけ機能であり、今後変更されたり無くなったりする可能性があります。

ONScripter 起動時に --edit オプションを指定することで有効になります。

任意のキー入力待ち状態時に z キーを押すことで、編集モードに入ります。この時、title bar に

[EDIT MODE]  MP3 vol (m)  SE vol (s)  Voice vol (v)  Numeric variable (n)

と表示されるはずです。この状態で、m, s, v, n のい ずれかのキーを押すことで、それぞれの値を変更するサブモードに入ります。 また、Esc キーを押すことによってモードを抜けることができます。

数字変数の場合は、値変更の前にどの変数を変更するのかを選択します。

値変更サブモードでは、0 から 9 までの数字と -, BackSpace, Esc, リター ンキーが使えます。- キーは、対象が数字変数でかつ数字が0の時のみ有効に なります。既に数字が入力されている場合には、一旦 BackSpace で数字を全 部消してから - キーを押してください。

Displaying Kanji characters using TrueType font

Japanese TrueType font is required to display Kanji characters. For example, msgothic.ttc under c:\Windows\Fonts in Windows 7, or freely available TrueType fonts shown below can be used.

M+ and IPA compositional font

Re-distributable fonts based on M+ font and IPA font. Among them, I recommend Migu-2M-bold.ttf that is bold, beautiful and easy-to-read.

IPA font

Re-distributable Gothic and Mincho font.

Mika-chan font

Handwritten font.

Because SDL_ttf renders Kanji characters badly when TTF_STYLE_BOLD is enabled, ONScripter just ignores "bold" settings. If you use a small device like smartphones, it is better to use a bold TrueType font such as Migu-2M-bold.ttf mentioned above and HG Gothic E (HGRGE.TTC).

TrueType font file should be renamed to default.ttf and be placed in the same directory where a script file is placed before launching ONScripter.

Using sound files instead of CD audio

Create a directory named "cd" in the directory where scripts and archives are placed, and put sound files as follows.
cd/track01.xxx
cd/track02.xxx
cd/track03.xxx
...
cd/track14.xxx
...
MP3, OGG and WAV format are supported. Please change the above "xxx" according to the format of the sound files.

The behavior of a command to play the first CD audio track, i.e. play "*1", is changed to play "track01.mp3". This is the default behavior unless "--cdaudio" option is specified. In case of missing sound files, "play" command is just ignored.

Playing MIDI

MIDI is played by SDL_mixer. At that time, a temporary file "tmp.mus" is created because SDL_mixer can only load MIDI data from a file.

Unix系(動作確認は Linux と Zaurus)でソフトウェア音源で演奏する場合（デフォルト）。

SDL_mixer に取り込まれている timidity を使用してソフトウェア音源で演奏します。この場合、MIDIの音色データtimidity.tar.gzをダウンロードして /usr/local/lib/ 以下に展開してください。

Windows の場合。

timidity.tar.gzをダウンロードして c:\ 以下に展開してください。 これをしなくても MIDI が鳴ったと思っていたのですが、こうしないと落ちるようです。

Mac OS X の場合。

ONScripter for Mac OS X（かつらさん）のバイナリに添付されている外部プログラムを利用して演奏が可能です。（当方未確認）

Unix系(動作確認は Linux)で外部 MIDI 音源を利用して演奏する場合。

playmidi 等の外部音源を使用できる MIDI player をインストールし、環境変数 MUSIC_CMD を設定してください。（例 MUSIC_CMD=/usr/bin/playmidi）
当方では、シリアル接続で外部音源を繋ぎ、MUSIC_CMD に '/usr/bin/midiplay -q -o /dev/ttyS0' を設定して動作確認をしています。
playmidiは、カーネルで認識される MIDI ポートに対してしか演奏できませんが、midiplayはシリアルに直接出せます。
シリアルポートをMIDIポートにする patchを使えば、playmidi でもシリアル接続音源を使えそうですが、未確認です。

Compression of archives

昔のZaurus (320x240) や PSP (360x270) などは画面の大きさが小さいた め、あらかじめアーカイブ中の画像ファイルを画面サイズに合わせて小さくし ておくことにより、アーカイブサイズを縮小し、少ない記憶デバイスを有効活 用することができます。なお、SPB 圧縮の画像は、後述の -e オプションを指 定しない場合 BMP 形式として格納されます。

使い方

sarconv                    変換元画面幅 変換先画面幅 変換元SARファイル名 変換先SARファイル名 
nsaconv [-e] [-ns2] [-ns3] 変換元画面幅 変換先画面幅 変換元NSAファイル名 変換先NSAファイル名 

変換元画面幅は 640 か 800 のいずれかを指定してください。

変換先画面幅は 176(iPod), 320(QVGA), 360(PSP), 384(PSP), 640(VGA) などが指定できます。

使用例

画面のサイズが 640x480 で拡張子が sar のアーカイブを 320x240 にする 場合

> sarconv 640 320 arc.sar zaurus_dir/arc.sar
...

画面のサイズが 800x600 で拡張子が nsa のアーカイブ（バージョン１） を 320x240 にする場合

> nsaconv [-e] 800 320 arc.nsa zaurus_dir/arc.nsa
> nsaconv [-e] 800 320 arc1.nsa zaurus_dir/arc1.nsa
...

画面のサイズが 800x600 で拡張子が nsa のアーカイブ（バージョン２） を 640x480 にする場合

> nsaconv [-e] -ns2 800 640 arc.nsa zaurus_dir/arc.nsa
> nsaconv [-e] -ns2 800 640 arc1.nsa zaurus_dir/arc1.nsa
...

NSA アーカイブのバージョン１と２と３の区別は手動です。スクリプトで ns2 コマンドが使われていればバージョン２、ns3 コマンドが使われていればバージョン３です。スクリプトが確認できない場合は、まず -ns2 を付けずに試し、うまくいかなかったら -ns2 もしくは -ns3 を付けて試してください。

-e オプションを付けると、wav と bmp ファイルを nbz 圧縮します。これを行うと、NSA アーカイブの圧縮の種類を示すフラグに ONScripter 独自の値を設定します。この独自拡張については、本家が将来アーカイブの仕様を拡張したときにバッティングする可能性がありますが、その時はそれを回避するようにコンバータを修正し、再コンバートすることで解決できます。その場合でも、save file 等には一切影響がありませんので、Zaurus で使用される方はこのオプションを付けてコンバートすることをお勧めします。wav を bzip2 で圧縮するので、wav を多用するゲームではかなりアーカイブが小さくなります。デメリットとしては、bzip2 の復号を行うため若干遅くなりますが、気が付かない程度です。

-j オプションを付けると、ファイル名はそのままで bmp ファイルを jpeg に変換します。ただし、パレットカラーの bmp ファイルは bmp のまま変換されます。

-q オプションで jpeg で圧縮する際の品質（０〜１００）を指定することができます。小さい値を指定すると、品質が悪くなりますが、圧縮後のサイズが小さくなります。デフォルトとは７５です。

サイズを小さくしたアーカイブを使うときは、onscripter に --disable-rescale オプションを指定してください。
なお、Linux 等でも、-DPDA をつけてコンパイルすることにより、320x240 画 面でゲームを実行することができます。

Problem of chattering MP3 music on Windows platform

Windows でコンパイル済の SMPEG のバイナリを持ってくると、MP3 によっては音がぶつぶつとぎれて演奏されます。これは、SMPEG を MSVC でコンパイルする時の最適化の問題で、下記の通りに MSVC の global optimization を一部抑制する指定をし、自分でコンパイルすることで解決できます。

修正するファイル: audio/mpeglayer3.cpp
関数 layer3reorderandantialias の前後に、下のように #pragma 指定を追加 する。

#pragma optimize( "g", off )
void MPEGaudio::layer3reorderandantialias(int ch,int gr,
                                          REAL  in[SBLIMIT][SSLIMIT],
                                          REAL out[SBLIMIT][SSLIMIT]){
  ......
}
#pragma optimize( "g", on )

How to write an English novel

これは Chend さん(chendo[at]gmail.com)からの要望に基づく ONScripter 独自の拡張です。これまで、仕様の提案やパッチなど多くの協力をしていただ きました。

コンパイル時に ENABLE_1BYTE_CHAR を定義することで、`(back quote) 以 降行末もしくは別の ` までを、1byte 文字で記述されたテキスト文とみなし て表示するようにします。この間では半角スペースが表示として有効になりま すが、テキスト内の変数表示は無効になり、また色・時間指定も開始位置によっ ては無効になります。テキスト途中で色を変える場合は、/ で行を分けるなど してください。ただし、クリック待ち(@)改ページ待ち(\)直後の強制クリック 文字を無視(_)は有効です。

将来本家で ` に何か機能を割り振った場合には、削除もしくは別の文字に 変更される可能性があります。現状のように ENABLE_1BYTE_CHAR の指定の有 無で使い分けられるようにするかもしれませんが、保証の限りではありません。

また、コンパイル時に ENABLE_1BYTE_CHAR と合わせて FORCE_1BYTE_CHAR を指定すると、全ての表示を半角にすることが可能になります。具体的には、 上記に加えて、右クリックメニューの表示が英語になり、また数字変数の表示 が半角になります。

以下にスクリプト例を書きます。

*define 
clickstr `.?"`, 2 
savename `Save the scene`, `Load the scene`, "Memory "
rmenu `Save to file`,save,`Load from file`,load
game
 
*start
`Hi, this was test.
`Hi, this is test again.
`_"He said so."
`_"She said so."
`Does it work??
br
selgosub `Say "Turn to the right."`, *right, 
`Say "Turn to the left."`, *left ,
"`Do nothing.", *nothing
end 

*right
`You turned to the right.
return

*left
`You turned to the left.
return

*nothing
`You didn't do anything.
return

Memo

event_mode

The values in the table below are used exclusively.

The values in the table below are used conjunction with the values in the table above.

Order of rendering layers

In the table below, the lower layer is hidden by the upper layer. The initial value of "humanz" is 499.

Text is always rendered at the top when appeared.