aboutsummaryrefslogtreecommitdiff
path: root/games/bstone/bstone.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2023-01-11 14:08:16 -0500
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2023-01-14 08:50:29 +0700
commit2c4b5f37a96f63c8d44b6d723ebc251fe201e96f (patch)
treea72d7a48a2aef177d40d3c1db46565e4e645348b /games/bstone/bstone.rst
parentc471d8241b0f5330f5a4b66392d01134963f76e0 (diff)
games/bstone: Updated for version 1.2.12.
Signed-off-by: B. Watson <urchlay@slackware.uk> Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'games/bstone/bstone.rst')
-rw-r--r--games/bstone/bstone.rst288
1 files changed, 207 insertions, 81 deletions
diff --git a/games/bstone/bstone.rst b/games/bstone/bstone.rst
index 83ee8fd209a64..d24683b4781aa 100644
--- a/games/bstone/bstone.rst
+++ b/games/bstone/bstone.rst
@@ -2,13 +2,9 @@
.. rst2man.py bstone.rst > bstone.6
.. rst2man.py comes from the SBo development/docutils package.
-.. |version| replace:: 1.1.7
+.. |version| replace:: 1.1.12
.. |date| date::
-.. converting from pod:
-.. s/B<\([^>]*\)>/**\1**/g
-.. s/I<\([^>]*\)>/*\1*/g
-
======
bstone
======
@@ -64,97 +60,227 @@ see /usr/doc/bstone-|version|/README.md
OPTIONS
=======
-.. notice the **-opt** *param* stuff? rst's option recognition
-.. can't handle non-GNU-style options like -option (it thinks the
-.. option is -o, and the ption is the parameter). So we have to help
-.. it out a little.
+**--version**
+ Outputs the port's version to standard output and into message box.
-*--version*
- Outputs the port's version to standard output and
- into message box.
+**--aog_sw**
+ Switches the port to "Blake Stone: Aliens Of Gold (shareware)" mode.
+ If appropriate data files are not found, the port will fail.
-*--aog_sw*
- Switches the port to Blake Stone: Aliens of Gold (shareware, v3.0) mode.
- If appropriate data files will not be found the port will fail.
- Default switch strategy: AoG (full) -> AoG (SW) -> PS
+**--aog**
+ Switches the port to "Blake Stone: Aliens Of Gold" mode.
+ If appropriate data files are not found, the port will fail.
-*--aog_10*
- Switches the port to Blake Stone: Aliens of Gold (full, v1.0) mode.
- If appropriate data files will not be found the port will fail.
- Default switch strategy: AoG (full) -> AoG (SW) -> PS
+**--ps**
+ Switches the port to "Blake Stone: Planet Strike" mode.
+ If appropriate data files are not found, the port will fail.
-*--aog_2x*
- Switches the port to Blake Stone: Aliens of Gold (full, v2.0/v2.1) mode.
- If appropriate data files will not be found the port will fail.
- Default switch strategy: AoG (full) -> AoG (SW) -> PS
+**--no_screens**
+ Skips start-up screens and the ending promo pages (AOG SW).
-*--aog_30*
- Switches the port to Blake Stone: Aliens of Gold (full, v3.0) mode.
- If appropriate data files will not be found the port will fail.
- Default switch strategy: AoG (full) -> AoG (SW) -> PS
+**--cheats**
+ Enables so called "debug mode" without much fuss.
-*--ps*
- Switches the port to Blake Stone: Planet Strike (full, v1.0/v1.1) mode.
- If appropriate data files will not be found the port will fail.
- Default switch strategy: AoG (full) -> AoG (SW) -> PS
+**--data_dir** dir
+ Specifies a directory with game's resource files.
+ Default: */usr/share/games/bstone*
-*--no_screens*
- Skips start-up screens (AoG/PS) and ending promo pages (AoG SW only).
+**--mod_dir** dir
+ Specifies a directory with mod's resource files.
+ Default: undefined.
-*--cheats*
- Enables so called "debug mode" without much fuss.
+**--profile_dir** dir
+ Overrides default directory of the game's profile files.
+ Default: *~/.local/share/bibendovsky/bstone/*
+
+**--vid_renderer** value
+ Select a renderer.
+ Values:
+
+ - auto_detect - tries to select the best renderer.
+ - software - the vanilla renderer.
+ - gl_2_0 - OpenGL 2.0 or higher.
+ - gl_3_2_c - OpenGL 3.2 core or higher.
+ - gles_2_0 - OpenGL ES 2.0 or higher.
-*--data_dir path_to_data*
- Specifies location to the game's data files.
- Default: /usr/share/games/bstone/
-
-*--profile_dir path*
- Overrides default location of the game's profile files. Config files
- and savegames are written here.
- Default: .local/share/bibendovsky/bstone/
-
-*--vid_renderer [soft|ogl]*
- Forces to use a specified renderer.
- "soft" selects a software renderer.
- "ogl" selects an OpenGL 2.x compatible renderer.
- Default order without this option: ogl, soft.
-
-*--vid_windowed*
- Runs the game in windowed mode.
- Default video mode: 640x480
-
-*--vid_mode width height*
- Selects the specified resolution for windowed mode.
- Without this option the game will use desktop's resolution.
- Minimum width: 640
- Minimum height: 480
-
-*--vid_scale factor*
- Refinement factor. The higher a value the greater internal resolution
- mode will be used to render a scene. The dimensions of the resolution mode
- are proportional to the original one (320x200) by 'factor' value.
- This option can greatly affect the performance of a renderer (especially a
- software one).
- Minimum factor: 1 (identical to the original game)
- Default factor: depends on the game's resolution mode.
-
-*--vid_window_x offset*
+ Default: auto_detect
+
+**--vid_width** width
+ Specifies window width.
+ Minimum width: 320
+ Default width: 640
+
+**--vid_height** height
+ Specifies window height.
+ Minimum height: 240
+ Default height: 480
+
+**--vid_x** offset
Sets a horizontal offset from the left side of the desktop screen.
- Applicable for windowed mode only.
+ Applicable for positionable window only.
+ Default: 0
-*--vid_window_y offset*
+**--vid_y** offset
Sets a vertical offset from the top side of the desktop screen.
- Applicable for windowed mode only.
-
-*--snd_rate sampling_rate*
+ Applicable for positionable window only.
+ Default: 0
+
+**--vid_is_positioned** value
+ Centers a window on the desktop or moves it in the specified position.
+ Values: 0 (centered) or 1 (positioned)
+ Default: 0
+
+**--vid_is_vsync** value
+ Enables or disables vertical synchronization.
+ Values: 0 (disable) or 1 (enable)
+ Default: 1
+
+**--vid_is_widescreen** value
+ Enables or disables widescreen rendering.
+ Values: 0 (disable) or 1 (enable)
+ Default: 1
+
+**--vid_is_ui_stretched** value
+ Stretches the UI or keeps it at 4x3 ratio otherwise.
+ Values: 0 (non-stretched) or 1 (stretched)
+ Default: 0
+
+**--vid_2d_texture_filter** filter
+ Sets texturing filter for UI.
+ Applicable only for 3D-rendering.
+ Values: nearest or linear
+ Default: nearest
+
+**--vid_3d_texture_image_filter** filter
+ Sets texturing image filter for the scene.
+ Applicable only for 3D-rendering.
+ Values: nearest or linear
+ Default: nearest
+
+**--vid_3d_texture_mipmap_filter** filter
+ Sets texturing mipmap filter for the scene.
+ Applicable only for 3D-rendering.
+ Values: nearest or linear
+ Default: nearest
+
+**--vid_3d_texture_anisotropy** value
+ Sets anisotropy degree for the scene.
+ Value 1 or lower disables the filter.
+ Applicable only for 3D-rendering.
+ Values: [1..16]
+ Default: 1
+
+**--vid_texture_upscale_filter** filter
+ Sets texturing upscale filter.
+ Applicable only for 3D-rendering.
+ Values: none or xbrz
+ Default: none
+ **WARNING** xbrz is a high resource usage filter!
+
+**--vid_texture_upscale_xbrz_degree** degree
+ Sets a degree of xBRZ texturing upscale.
+ Applicable only for 3D-rendering.
+ Values: [2..6]
+ Default: 0
+
+**--vid_aa_kind** value
+ Sets an anti-aliasing mode.
+ Applicable only for 3D-rendering.
+ Values: none or msaa
+ Default: none
+
+**--vid_aa_degree** value
+ Sets a degree of the anti-aliasing.
+ Applicable only for 3D-rendering.
+ Values: [2..32]
+ Default: 1
+
+**--vid_filler_color_index** value
+ Sets a color for screen bars.
+ Values: [0..255]
+ Default: 0
+
+**--vid_external_textures** value
+ Toggles external textures.
+ Values: 0 (disable), 1 (enable).
+ Default: 0
+
+**--snd_is_disabled** value
+ Enables or disables audio subsystem.
+ Values: 0 (disable) or 1 (enable)
+ Default: 0
+
+**--snd_rate** sampling_rate
Specifies sampling rate of mixer in hertz.
- Default: 44100 Hz
- Minimum: 11025 Hz
+ Default: 44100
+ Minimum: 11025
-*--snd_mix_size duration*
+**--snd_mix_size** duration
Specifies mix data size in milliseconds.
- Default: 40 ms
- Minimum: 20 ms
+ Default: 40
+ Minimum: 20
+
+**--snd_driver** value
+ Specifies the audio driver to use.
+ Values: auto-detect, 2d_sdl (2D SDL), 3d_openal (3D OpenAL)
+ Default: auto-detect
+ Auto-detect order: 3d_openal, 2d_sdl
+
+**--snd_oal_library** value
+ Specifies OpenAL driver's name.
+ Default: "" (OpenAL32.dll on Windows and libopenal.so on non-Windows system).
+
+**--snd_oal_device_name** value
+ Specifies OpenAL device name.
+ Default: ""
+
+**--snd_sfx_type** value
+ Specifies SFX type.
+ Values: adlib (AdLib) or pc_speaker (PC Speaker)
+ Default: adlib
+
+**--snd_is_sfx_digitized** value
+ Toggles SFX digitization.
+ If enabled overrides AdLib / PC Speaker SFX audio chunk if such one is available in AUDIOT.* file.
+ Values: 0 (disable) or 1 (enable)
+ Default: 1
+
+**--snd_opl3_type** value
+ Specifies OPL3 emulator type.
+ Values: dbopl (DOSBox) or nuked (Nuked)
+ Default: dbopl
+
+**--calculate_hashes**
+ Calculates hashes (SHA-1) of all resource files and outputs them into the log.
+
+**--extract_vga_palette** dir
+ Extracts VGA palette into existing directory dir.
+ Supported file format: **.bmp**
+
+**--extract_walls** dir
+ Extracts graphics resources (wall, flooring, etc.) into existing directory dir.
+ Supported file format: **.bmp**
+
+**--extract_sprites** dir
+ Extracts graphics resources (actors, decorations, etc.) into existing directory dir.
+ Supported file format: **.bmp**
+
+**--extract_music** dir
+ Extracts music resources into existing directory dir.
+ Supported file format: **.wav**
+ Supported file format: data (unprocessed)
+
+**--extract_sfx** dir
+ Extracts sfx resources into existing directory dir.
+ Supported file format: **.wav**
+ Supported file format: data (unprocessed)
+
+**--extract_texts** dir
+ Extracts text resources into existing directory dir.
+ Supported file format: **.txt**
+
+**--extract_all** dir
+ Extracts all resources (walls, sprites, etc.) into existing directory dir.
COPYRIGHT
=========