diff --git a/doc/ENVIRON.rst b/doc/ENVIRON.rst index 7302fc701..08d5795e8 100644 --- a/doc/ENVIRON.rst +++ b/doc/ENVIRON.rst @@ -56,6 +56,22 @@ Virtual filesystem - On **Linux**, **\*BSD**, and most other **Unix**-like systems, it's ``$XDG_DATA_HOME/taisei`` or ``$HOME/.local/share/taisei``. +**TAISEI_CACHE_PATH** + | Default: unset + + If set, overrides the default **cache directly** path. This is where + Taisei stores transcoded Basis Universal textures and translated shaders + to speed up future loading times. + + - On **Windows**, it's ``%LOCALAPPDATA%\taisei\cache``. + - On **macOS**, it's ``$HOME/Library/Caches/taisei``. + - On **Linux**, **\*BSD**, and most other **Unix**-like systems, + it's ``$XDG_CACHE_HOME/taisei`` or ``$HOME/.cache/taisei``. + + It is safe to delete this directly; Taisei will rebuild the cache as it + loads resources. If you don't want Taisei to write a persistent cache, + you can set this to a non-writable directory. + Resources ~~~~~~~~~ @@ -93,6 +109,31 @@ Resources If ``1``, Taisei will load all shader programs at startup. This is mainly useful for developers to quickly ensure that none of them fail to compile. +**TAISEI_AGGRESSIVE_PRELOAD** + | Default: ``0`` + + If ``1``, Taisei will scan all available resources and try to load all of + them at startup. Implies ``TAISEI_NOUNLOAD=1``. + +**TAISEI_BASISU_FORCE_UNCOMPRESSED** + | Default: ``0`` + + If ``1``, Basis Universal-compressed textures will be decompressed on the + CPU and sent to the GPU in an uncompressed form. For debugging. + +**TAISEI_BASISU_MAX_MIP_LEVELS** + | Default: ``0`` + + If ``>0``, limits the amount of mipmap layers loaded from Basis Universal + textures. For debugging. + +**TAISEI_BASISU_MIP_BIAS** + | Default: ``0`` + + If ``>0``, makes Taisei load lower resolution versions of Basis Universal + textures that have mipmaps. Each level halves the resolution in each + dimension. + Video and OpenGL ~~~~~~~~~~~~~~~~ @@ -160,6 +201,27 @@ Video and OpenGL Displays some statistics about usage of in-game objects. +**TAISEI_ANGLE_WEBGL** + | Default: ``0``; ``1`` on Windows + + If ``1`` and the gles30 renderer backend has been configured to use ANGLE, + it will create a WebGL-compatible context. This is needed to work around + broken cubemaps in ANGLE's D3D11 backend. + +Audio +~~~~~ + +**TAISEI_AUDIO_BACKEND** + | Default: ``sdl`` + + Selects the audio playback backend to use. Currently available options are: + + - ``sdl``: the SDL2 audio subsystem, with a custom mixer + - ``null``: no audio playback + + Note that the actual subset of usable backends, as well as the default + choice, can be controlled by build options. + Timing ~~~~~~ @@ -198,6 +260,24 @@ Timing cases. ``TAISEI_FRAMELIMITER_SLEEP``, ``TAISEI_FRAMELIMITER_COMPENSATE``, and the ``frameskip`` setting have no effect in this mode. +Demo Playback +~~~~~~~~~~~~~ + +**TAISEI_DEMO_TIME** + | Default: ``3600`` + + How much time (in frames) of user inactivity is required to begin playing + demo replays in the menu. If ``<=0``, demo playback will be disabled. + + +**TAISEI_DEMO_INTER_TIME** + | Default: ``1800`` + + How much time (in frames) of user inactivity is required to advance to the + next demo in the sequence in between demo playback. This delay will be reset + back to ``TAISEI_DEMO_TIME`` on user activity. + + Miscellaneous ~~~~~~~~~~~~~ diff --git a/src/main.c b/src/main.c index 61314776e..2e3e9f1c7 100644 --- a/src/main.c +++ b/src/main.c @@ -399,7 +399,7 @@ static void main_post_vfsinit(CallChainResult ccr) { events_init(); if(global.is_kiosk_mode) { - watchdog_init(env_get("TAISEI_KIOSK_TIMEOUT", 60 * FPS)); + watchdog_init(env_get("TAISEI_KIOSK_TIMEOUT", 120 * FPS)); events_register_handler(&(EventHandler) { .priority = EPRIO_SYSTEM, .event_type = MAKE_TAISEI_EVENT(TE_WATCHDOG),