steed/doc/instead.6

147 lines
2.7 KiB
Groff
Raw Normal View History

2011-03-29 13:12:17 +03:00
.TH INSTEAD 6 "Version 1.3.5" Instead GAMES
2009-09-15 13:06:58 +03:00
.SH NAME
2009-11-10 09:58:10 +02:00
INSTEAD - Simple Text Adventure Engine, The Interpreter
2009-09-15 13:06:58 +03:00
.SH DESCRIPTION
2009-11-13 18:01:27 +02:00
The interpreter of STEAD (Simple Text Adventures) allows to play games that combine visual novels, text adventures and classic quests of 1990-s.
2009-09-15 13:06:58 +03:00
The STEAD games features are:
.TP
* very simple source code of the stories. (based on LUA);
.TP
2009-11-10 09:58:10 +02:00
* the ability to use graphical or textual (readline) game interface;
2009-09-15 13:06:58 +03:00
.TP
* graphic interface supports music and images;
.TP
2009-09-15 13:14:08 +03:00
* graphic interpreter theme support \- a game may change the interface look;
2009-09-15 13:06:58 +03:00
.TP
* portability (originally written for Linux, depends on SDL and lua).
.SH SYNOPSIS
.B sdl-instead
2010-06-03 10:59:48 +03:00
.I [options] [game.zip to run]
2009-09-15 13:06:58 +03:00
.SH OPTIONS
.TP
.B -debug
Debug mode (for game developers).
.TP
.B -alsa
2009-11-10 09:58:10 +02:00
Force ALSA sound (Linux only).
2009-09-15 13:06:58 +03:00
.TP
.B -nosound
2009-11-10 09:58:10 +02:00
Run the game without sound.
2009-09-15 13:06:58 +03:00
.TP
.B -gamespath <path>
Add path with games.
.TP
.B -themespath <path>
Add path with themes.
.TP
2009-11-21 13:58:24 +02:00
.B -nostdgames
2009-11-21 14:24:04 +02:00
Do not use default games.
2009-11-21 13:58:24 +02:00
.TP
.B -nostdthemes
2009-11-21 14:24:04 +02:00
Do not use default themes.
2009-11-21 13:58:24 +02:00
.TP
2009-09-15 13:06:58 +03:00
.B -game <basename>
Select game in gamespath.
.TP
.B -theme <basename>
Select theme in themespath.
.TP
.B -fullscreen
2009-11-10 09:58:10 +02:00
Run the game in fullscreen mode.
2009-09-15 13:06:58 +03:00
.TP
.B -window
2009-11-10 09:58:10 +02:00
Run the game in windowed mode.
.TP
.B -noautosave
Disable autosave/autoload.
2009-10-16 18:35:28 +03:00
.TP
.B -encode <lua file> [encoded file]
Encode lua file. Encoded file can be executed with doencfile("encoded file").
2009-10-24 19:09:31 +03:00
.TP
.B -mode [WxH]
Use WxH resolution.
2010-01-26 11:32:30 +02:00
.TP
2010-03-12 20:06:15 +02:00
.B -nopause
Do not pause the game on window minimize.
.TP
2010-06-03 10:59:48 +03:00
.B -install [game in zip]
Install game from zip archive
.TP
.B -quit
Quit :)
.TP
2011-03-30 10:28:26 +03:00
.B -appdata [fullpath]
Store saves and settings in appdata path. Path must exist!
.TP
.B -chunksize [size in bytes]
Size for audio buffer. Try this if sound lags.
.TP
2010-01-26 11:32:30 +02:00
.B -version
Show version and exit.
2009-09-15 13:06:58 +03:00
.PP
Configuration file name is 'insteadrc' and it's located in ~/.instead/.
2009-11-10 09:58:10 +02:00
Games can be downloaded from http://instead.googlecode.com. Unzip them
2009-09-15 13:06:58 +03:00
in ~/.instead/games.
.SH CONTROLS
Please, see tutorial.
.SH LICENCE
This is free software; you can redistribute it and/or modify it
under the terms specified in the GNU Public Licence (GPL).
.SH WARRANTY
None.
.SH COPYRIGHT AND CREDITS
.TP
.B Peter Kosyh
2009-11-09 20:00:29 +02:00
INSTEAD author.
2009-10-06 14:11:01 +03:00
.TP
.B Ilya Ryndin
Initial port to Windows.
.TP
2010-11-29 14:56:41 +02:00
.B Mahno Aleksey
Port to Android.
.TP
.B .dm
Port to Mac OS X.
.TP
2010-11-30 07:14:48 +02:00
.B Andrey Afletdinov
2010-11-29 15:03:46 +02:00
Port to Windows CE.
2010-11-29 14:56:41 +02:00
.TP
2009-11-09 20:00:29 +02:00
.B Vadim Balashoff
Advices.
.TP
.B Vladimir Zhirov
Advices.
.TP
2009-11-10 08:17:41 +02:00
.B Alexander Yakovlev
manual.tex support.
.TP
2009-11-08 18:12:45 +02:00
.B Serj Kalichev
2009-11-09 20:00:29 +02:00
Advices and default theme correction.
2009-11-08 18:12:45 +02:00
.TP
2009-10-06 14:11:01 +03:00
.B Vladimir Podobaev, Oleg Gvozdev
Testers.
.TP
2010-11-30 09:55:46 +02:00
.B Alexander Soborov
Wiki support.
.TP
Many others for comments, bug reports, games and ideas.
2009-11-09 20:00:29 +02:00
.SH SEE ALSO
.BR http://instead.googlecode.com