$OpenBSD$

+-------------------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
+-------------------------------------------------------------------------------

Playing games
=============

Playing an existing game with ONScripter-EN requires two additional
files to be added to the game directory:

- `default.ttf', a TrueType font. The free font Sazanami Gothic
  (ja-sazanami-ttf) is known to work.

  $ cp ${TRUEPREFIX}/share/fonts/sazanami/sazanami-gothic.ttf ~/game/default.ttf

- Optionally, `game.id', a text file containing simply the name of the
  game. This is used to identify a separate directory where saved
  data is stored; unlike the original ONScripter, which places saved
  games in the game directory, ONScripter-EN does not require games to
  be kept in a world-writable location.

This done, the game can be played either by dropping the `onscripter'
executable into the game directory and running it, or by running it
with the `-r' command-line option to identify the desired game.

The saved game location behaviour can be overridden with the `-s'
command-line option if you wish for some reason to restore the default
ONScripter behaviour or to place saves somewhere else.

Please run `onscripter --help' for details of other command-line
options.

Window width
============

Create an optional config file, `ons.cfg', for command-line options. Insert
either `window-width=768' or `scale'. The corresponding command-line options
`--window-width' and `--scale'.

Saving
======

Right-click to display in-game menu and select save.

Controls
========

https://web.archive.org/web/20120723185149/http://unclemion.com/onscripter/pub/onscr/readme.onscr.txt

Text Speed:
1: slow
2: normal
3: fast
0: toggle slow/normal/fast

Scrolling:
K/up: move up one option
J/down: move down one option
H/left: go back one page
L/right: go forward one page

Misc:
M: toggle volume on / muted
F: toggle full screen / windowed mode
O: toggle display each page of text instantly
S: toggle fast forward
CTRL: super-fast forward while held down
ESC/right-click: display in-game menu

A: toggle automode (if enabled for game)

left-click/space/return/enter: advance the text (or select a highlighted option)

Tools
=====

onscripter-en includes tools for packing/unpacking NScr script files and
extracting/converting/creating NSA, NS2 and SAR archives. Refer to the man pages
for documentation.

nscdec(1) converts a packaged script file (e.g., "nscript.dat") to a text
script.

$ nscdec nscript.dat

nsadec(1) extracts files from an nsa archive file (e.g., "arc.nsa").

$ nsadec -o arc arc.nsa

FAQs
====

https://web.archive.org/web/20180927054354/http://unclemion.com/onscripter/faq/

Startup
-------
1. I have an NScripter game that I'm trying to run using ONScripter, but nothing
happens when I start onscripter-en. What's wrong with it?

You are probably missing the required font file, `default.ttf'. This zip archive
contains a font file based on the freely-available Linux Sazanami font, which
should do the job for most games. Put the `default.ttf' into your game directory
and restart onscripter-en.

2. I get the following error when I try to run onscripter-en: "Could not find
the font file `default.ttf'."

See answer to #1.

Playback
--------
3. My NScripter game had a menubar where I can change the text speed and
windowed/fullscreen settings, or have it skip through a scene. How do I do
these things in ONScripter?

ONScripter doesn't support menubars at this time, but you can use keystrokes to
accomplish the same tasks--check this list of keystroke commands.

4. I was playing a game using ONScripter-EN, and all of a sudden there's no
sound! How do I get it back?

You probably hit the `M' key, which toggles muting the sound. Try hitting it
again and see if the sound comes back.

5. I was playing a game using ONScripter, and all of a sudden it's showing
entire pages of text all at once instead of displaying them a bit at a time.
What's happening?

It's possible that the game is doing that intentionally (i.e. using a textspeed
of 0 at that point in the story), but you may have hit the `O' key, which
toggles `page-at-once' mode. Try hitting it again and see if any further text
display is back to normal.
