steed/doc/instead.6

101 lines
1.9 KiB
Groff
Raw Normal View History

2009-11-03 18:45:46 +02:00
.TH INSTEAD 6 "Version 1.0.0" Instead GAMES
2009-09-15 13:06:58 +03:00
.SH NAME
2009-09-15 13:14:08 +03:00
INSTEAD - Simple Text Adventure Engine, The Interpretor
2009-09-15 13:06:58 +03:00
.SH DESCRIPTION
The interpreter of STEAD (Simple Text Adventures) allows to play games, combining visual novels, text adventure and classic quests of 1990-s.
The STEAD games features are:
.TP
* very simple source code of the stories. (based on LUA);
.TP
* the ability to use graphic or textual (readline) game interface;
.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
.I [options]
.SH OPTIONS
.TP
.B -debug
Debug mode (for game developers).
.TP
.B -alsa
Force ALSA sound (for Linux only).
.TP
.B -nosound
Runs the game without sound.
.TP
.B -gamespath <path>
Add path with games.
.TP
.B -themespath <path>
Add path with themes.
.TP
.B -game <basename>
Select game in gamespath.
.TP
.B -theme <basename>
Select theme in themespath.
.TP
.B -fullscreen
Runs the game in fullscreen mode.
.TP
.B -window
Runs 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.
2009-09-15 13:06:58 +03:00
.PP
Configuration file name is 'insteadrc' and it's located in ~/.instead/.
You can download some games from: http://instead.googlecode.com. Unzip them
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-10-06 14:11:01 +03:00
Game author.
.TP
.B Serj Kalichev
Advices, default theme correction.
.TP
.B Ilya Ryndin
Initial port to Windows.
.TP
.B Vladimir Podobaev, Oleg Gvozdev
Testers.
.TP
2009-09-15 13:06:58 +03:00
Many others for comments, bug reports and ideas.