Skip to content

Commit 43c8bba

Browse files
normanbonnormanbon
authoredDec 10, 2024
Add files via upload
1 parent 6c2ed6a commit 43c8bba

File tree

1 file changed

+75
-70
lines changed

1 file changed

+75
-70
lines changed
 

‎template-base/vars.conf

+75-70
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,100 @@
11
### List of all TDF settings
2-
# For more info about possible values and details about what they do, see README.md here: https://github.com/adolfintel/TDF/blob/master/README.md#configuration-variables
2+
#For more info about possible values and details about how they work, see README.md here: https://github.com/adolfintel/TDF/blob/master/README.md#configuration-variables
33

4-
# --- VARIABLES - Basic configuration ---
4+
# [VARIABLES - Basic configuration]
55
game_exe=''
66
#game_args=''
77
#game_workingDir=''
88

9-
# --- VARIABLES - TDF stuff ---
10-
#TDF_TITLE=... #title for the TDF UI (says "Launcher" by default)
11-
#TDF_DETAILED_PROGRESS=1 #1=show info like "Installing DXVK", 0=just say "Launching..."
12-
#TDF_MULTIPLE_INSTANCES="askcmd" #deny=exit without error messages, error=show an error message and close, askcmd=ask the user if they want to run cmd inside the running prefix, cmd=run command prompt inside the running prefix, allow=allow multiple instances of the game
13-
#TDF_IGNORE_EXIST_CHECKS=0 #1=skip the check that game_exe actually exists before launching the game
14-
#TDF_HIDE_GAME_RUNNING_DIALOG=0
15-
#TDF_SHOW_PLAY_TIME=0 #1=show how long you've been playing when you close the game
9+
# [VARIABLES - Various]
10+
#TDF_DETAILED_PROGRESS=0 #1=Shows detailed info (for example: "Installing DXVK"). | 0=Shows only a "Launching..." message.
11+
#TDF_HIDE_GAME_RUNNING_DIALOG=1
12+
#TDF_IGNORE_EXIST_CHECKS=0 #1=Skips the check that game_exe actually exists before launching the game.
13+
#TDF_MULTIPLE_INSTANCES="askcmd" #deny=Exits without error messages. | error=Shows an error message and close. | askcmd=Asks the user if it wants to run cmd inside the running prefix. | cmd=Runs command prompt inside the running prefix. | allow=Allows multiple instances of the game.
14+
#TDF_SHOW_PLAY_TIME=0 #1=Shows how long you've been playing when you close the game.
15+
#TDF_TITLE='' #Title for the TDF UI ("Launcher" is displayed by default).
1616

17-
# --- VARIABLES - Wine ---
18-
#TDF_WINE_PREFERRED_VERSION="games" #games=game-optimized build, mainline=regular wine, custom=the build in the wine-custom folder outside the system folder, system=the version of wine that's installed on the system, or mainline if not installed, any other value will use system/wine-yourValue or system wine if not found
19-
#TDF_WINE_HIDE_CRASHES=1 #1=hide the "stopped working" window if the game crashes (recommended)
20-
#TDF_WINE_AUDIO_DRIVER="default" #pulse,alsa,jack,default (let wine decide)
21-
#TDF_WINE_GRAPHICS_DRIVER="default" #x11,wayland,default (let wine decide)
22-
#TDF_WINE_DPI=-1 #-1=use system dpi, 0=let wine decide, number=use specified dpi
23-
#TDF_WINE_KILL_BEFORE=0 #1=explicitly kill the wine processes before launching the game (not recommended)
24-
#TDF_WINE_KILL_AFTER=0 #1=explicitly kill the wine processes when the game ends (not recommended)
25-
#TDF_START_ARGS='' #additional arguments to pass to wine's start command, such as /affinity 1
26-
#TDF_UI_LANGUAGE='' #language for the TDF UI (only 'en' or 'it' at the moment)
27-
#TDF_WINE_LANGUAGE='' #language for wine applications. By default it's set to your $LANG, you can force any locale in the standard format, like 'en_US.UTF-8'
28-
#TDF_WINE_ARCH="win64" #win64=emulate 64bit windows, win32=emulate 32bit windows (useful for older games). cannot be changed after wineprefix initialization
29-
#TDF_WINE_SYNC="fsync" #fsync=use fsync if futex2 is available, otherwise esync, esync=always use esync, default=let wine decide. Only supported by games build, other versions will ignore this parameter
30-
#TDF_WINE_DEBUG_RELAY=0 #1=intercept all system calls and dump them to a file (for debugging)
31-
#TDF_WINE_DEBUG_GSTREAMER=0 #1=enable gstreamer debug output on the terminal (for debugging video problems)
32-
#TDF_WINE_SMOKETEST=1 #1=make sure that wine actually works before trying to launch the game, set to 0 for faster loading
33-
#TDF_WINEMONO=0 #1=enable wine mono for .net applications (not usually needed for games)
34-
#TDF_WINEGECKO=0 #1=enable wine gecko for applications that need IE (not usually needed for games)
35-
#TDF_WINE_NOSMT=0 #1=don't show hyperthreading/SMT to the application (if present in the system). Only supported by games build, other versions will ignore this parameter
36-
#TDF_WINE_NOECORES=0 #1=don't show e-cores to the application. Only supported by games build, other versions will ignore this parameter
37-
#TDF_WINE_PREFER_SAMESOCKET=1 #0=assign cores based on speed exclusively, 1=assign based on speed, but first use all the cores on the first CPUs then use the others, 2=only show the first CPU to the application and ignore the others. This can be useful if you're gaming on a multi-CPU server or something. Only supported by games build, other versions will ignore this parameter
38-
#TDF_WINE_MAXLOGICALCPUS=0 #the maximum number of logical CPUs (aka hardware threads, the ones you see in task manager) that the application can use. If the number of logical CPUs in the machine exceeds this, TDF will limit how many can be used by the application assigning them "intelligently" to maximize gaming performance. Set to 0 to disable limit. Only supported by games build, other versions will ignore this parameter
17+
# [VARIABLES - Wine]
18+
#export WINE_CPU_TOPOLOGY=...
3919
#export WINE_LARGE_ADDRESS_AWARE=1
20+
#export WINE_HEAP_DELAY_FREE=0 #Set to 1 to workaround some crashes caused by bad memory management in some old games and applications.
4021
#export WINEDEBUG=-all
4122
#export WINEDLLOVERRIDES=''
42-
#export WINE_CPU_TOPOLOGY=...
43-
#export WINE_HEAP_DELAY_FREE=0 #set to 1 to workaround some crashes caused by bad memory management in some old games and applications
23+
#TDF_START_ARGS='' #Additional arguments to pass to Wine's start command, such as /affinity 1.
24+
#TDF_UI_LANGUAGE='' #Language for the TDF UI (currently available options: 'en', 'it').
25+
#TDF_WINE_ARCH="win64" #win64=Emulates 64-bit Windows. | win32=Emulates 32-bit Windows (useful for older games). WARNING: cannot be changed after wineprefix initialization.
26+
#TDF_WINE_AUDIO_DRIVER="default" #alsa | jack | pulse | default (lets Wine decide).
27+
#TDF_WINE_DEBUG_GSTREAMER=0 #1=Enables GStreamer debug output on the terminal (for debugging video problems).
28+
#TDF_WINE_DEBUG_RELAY=0 #1=Intercepts all system calls and dump them to a file (for debugging purposes).
29+
#TDF_WINE_DPI=-1 #-1=Uses system DPI. | 0=Let Wine decide | number=Uses specified DPI.
30+
#TDF_WINE_GRAPHICS_DRIVER="default" #wayland | x11 | default (lets Wine decide).
31+
#TDF_WINE_HIDE_CRASHES=1 #1=Hides the "stopped working" window if the game crashes. [Recommended]
32+
#TDF_WINE_KILL_AFTER=0 #1=Explicitly kills the Wine processes when the game ends. [Not recommended]
33+
#TDF_WINE_KILL_BEFORE=0 #1=Explicitly kills the Wine processes before launching the game. [Not recommended]
34+
#TDF_WINE_LANGUAGE='' #Language for Wine applications. By default it is set to your $LANG. You can force any locale in the standard format, such as 'en_US.UTF-8'.
35+
#TDF_WINE_MAXLOGICALCPUS=0 #The maximum number of logical CPUs (also known as hardware threads, the ones you see in task manager) that the application can use. If the number of logical CPUs in the machine exceeds this, TDF will limit how many can be used by the application assigning them "intelligently" to maximize gaming performance. Set to 0 to disable limit. Only supported by games build, other versions will ignore this parameter.
36+
#TDF_WINE_NOSMT=0 #1=Doesn't show hyperthreading/SMT to the application (if present on the system). Only supported by games build, other versions will ignore this parameter.
37+
#TDF_WINE_PREFER_SAMESOCKET=1 #0=Assigns cores exclusively on speed. | 1=Assigns cores based on speed, but first use all the cores on the first CPUs then use the others. | 2=Shows only the first CPU to the application and ignores the others. This can be useful if you're gaming on a multi-CPU server or something similar. Only supported by games build, other versions will ignore this parameter.
38+
#TDF_WINE_PREFERRED_VERSION="games" #games=Game-optimized build. | mainline=Regular Wine. | custom=The build in the wine-custom folder outside the system folder. | system=The Wine version installed on the system or mainline if not installed. Any other value will use system/wine-yourValue or system Wine if not found.
39+
#TDF_WINE_SYNC="fsync" #fsync=Uses fsync if futex2 is available, otherwise esync. | esync=Always uses esync. | default=Lets wine decide. Only supported by games build, other versions will ignore this parameter.
40+
#TDF_WINE_SMOKETEST=1 #1=Makes sure that Wine actually works before trying to launch the game, set to 0 for faster loading.
41+
#TDF_WINEGECKO=0 #1=Enables Wine gecko for applications that need Internet Explorer (not usually needed for games).
42+
#TDF_WINEMONO=0 #1=Enables Wine mono for .NET applications (not usually needed for games).
43+
#TDF_WINE_NOECORES=0 #1=Doesn't show e-cores to the application. Only supported by games build, other versions will ignore this parameter.
4444
#See here for additional wine settings: https://www.winehq.org/docs/en/wineusr-guide.html
4545

46-
# --- VARIABLES - DXVK (DX8-11 emulation) ---
46+
# [VARIABLES - DXVK (DirectX 8 to 11 emulation)]
4747
#TDF_DXVK=1
48-
#TDF_DXVK_NVAPI=0 #set to 1 to enable nvapi (nvidia gpus only)
49-
#TDF_DXVK_ASYNC=2 #0=always use regular dxvk, 1=always use async version, 2=use regular dxvk if the gpu supports gpl, async if it doesn't
50-
#See here for additional settings to be put in a dxvk.conf file next to the game's exe file: https://github.com/doitsujin/dxvk/blob/master/dxvk.conf
48+
#TDF_DXVK_ASYNC=2 #0=Always uses regular DXVK. | 1=Always uses async version. | 2=Uses regular DXVK if the GPU supports gpl, async if it doesn't.
49+
#TDF_DXVK_NVAPI=0 #Set to 1 to enable nvapi (Nvidia GPUs only).
50+
#For additional settings to add in a dxvk.conf file next to the game's exe file, see here: https://github.com/doitsujin/dxvk/blob/master/dxvk.conf
5151

52-
# --- VARIABLES - VKD3D (DX12 emulation) ---
52+
# [VARIABLES - VKD3D (DirectX 12 emulation)]
5353
#TDF_VKD3D=1
54-
#See here for additional settings: https://github.com/HansKristian-Work/vkd3d-proton/blob/master/README.md#environment-variables
54+
#For additional settings, see here: https://github.com/HansKristian-Work/vkd3d-proton/blob/master/README.md#environment-variables
5555

56-
# --- VARIABLES - Sandboxing ---
57-
#TDF_BLOCK_NETWORK=1 #0=allow network access, 1=block with unshare -nc, 2=block with firejail if available, unshare -nc if it's not
58-
#TDF_BLOCK_BROWSER=1 #0=wine apps can launch the native browser, 1=block browser access (recommended)
59-
#TDF_BLOCK_ZDRIVE=1 #1=wine apps can't access the linux file system (after installation)
60-
#TDF_BLOCK_EXTERNAL_DRIVES=1 #1=wine apps can't access external drives like CDs and USBs (after installation)
61-
#TDF_BLOCK_SYMLINKS_IN_CDRIVE=1 #1=remove symlinks from the virtual C drive (makes it harder to escape the sandbox)
62-
#TDF_FAKE_HOMEDIR=0 #create a zzhome folder to be used as a temporary home, useful if the game needs a custom .driconf or similar tweaks
63-
#TDF_PROTECT_DOSDEVICES=0 #prevents wine from modifying drive mappings. Not necessary when using the games and mainline builds. Can cause hangs when enabled
56+
# [VARIABLES - Sandboxing]
57+
#TDF_BLOCK_BROWSER=1 #0=Wine applications can launch the native browser. | 1=Blocks browser access. [Recommended]
58+
#TDF_BLOCK_EXTERNAL_DRIVES=1 #1=Wine applications can't access external drives, for example CD and USB drives (after installation). [Recommended]
59+
#TDF_BLOCK_NETWORK=1 #0=Allows network access. | 1=Blocks with unshare -nc. [Recommended] | 2=Blocks with firejail if available, unshare -nc if it's not.
60+
#TDF_BLOCK_SYMLINKS_IN_CDRIVE=1 #1=Removes symlinks from the virtual C drive (makes it harder to "escape" the sandbox).
61+
#TDF_BLOCK_ZDRIVE=1 #1=Wine applications can't access the Linux file system (after installation).
62+
#TDF_FAKE_HOMEDIR=0 #Creates a zzhome folder to be used as a temporary home, useful if the game needs a custom .driconf or similar tweaks.
63+
#TDF_PROTECT_DOSDEVICES=0 #Prevents Wine from modifying drive mappings. Not necessary when using the games and mainline builds. Can cause hangs when enabled.
6464

65-
# --- VARIABLES - Gamescope ---
66-
#TDF_GAMESCOPE=0 #1=run the game through gamescope (if installed in the system)
67-
#TDF_GAMESCOPE_PARAMETERS='' #if not changed in config, this will become -f -r 60 -w $XRES -h $YRES -- where $XRES and $YRES are the resolution of the main display
65+
# [VARIABLES - Gamescope]
66+
#TDF_GAMESCOPE=0 #1=Runs the game through Gamescope (if installed on the system).
67+
#TDF_GAMESCOPE_PARAMETERS='' #If not changed in config, this will become -f -r 60 -w $XRES -h $YRES -- where $XRES and $YRES are the resolution of the main display.
6868

69-
# --- VARIABLES - Miscellaneous ---
70-
#TDF_GAMEMODE=1 #1=use feral gamemode (if installed in the system)
71-
#TDF_MANGOHUD=0 #1=show an afterburner style performance overlay (if installed in the system)
72-
#TDF_COREFONTS=1 #1=install basic windows fonts such as Arial
73-
#TDF_VCREDIST=1 #install MS visual studio runtime (2015+)
74-
#export DRI_PRIME=... #which GPU to use (0=first GPU, 1=second GPU, etc.)
75-
#export SteamGameId=... #steam appid for this game (activates some game-specific fixes in the games build)
69+
# [VARIABLES - Miscellaneous]
70+
#export DRI_PRIME=... #Select which GPU to use (0=First GPU, 1=Second GPU etc.).
71+
#export SteamGameId=... #Steam Appplication ID for this game (activates some game-specific fixes in the games build).
72+
#TDF_COREFONTS=1 #1=Installs basic Windows fonts such as Arial.
73+
#TDF_GAMEMODE=1 #1=Uses feral gamemode (if installed on the system).
74+
#TDF_MANGOHUD=0 #1=Shows an MSI Afterburner-style performance overlay (if installed on the system).
75+
#TDF_VCREDIST=1 #Installs Microsoft Visual Studio runtime (2015+).
7676

77-
# --- CALLBACKS ---
78-
#customChecks(){
79-
# code to be executed immediately after the configuration is loaded
77+
# [CALLBACKS]
78+
#customChecks() {
79+
# Code to be executed immediately after the configuration is loaded.
8080
#}
81-
#onGameStart(){
82-
# code to be executed right before the game is launched
81+
82+
#onGameStart() {
83+
# Code to be executed right before the game is launched.
8384
#}
84-
#onGameEnd(){
85-
# code to be executed right after the game is closed
85+
86+
#onGameEnd() {
87+
# Code to be executed right after the game is closed.
8688
#}
87-
#whileGameRunning(){
88-
# code to be executed while the game is running. Runs in a separate subshell, use isProcessRunning "game.exe" to know if the process is still running
89+
90+
#whileGameRunning() {
91+
# Code to be executed while the game is running. Runs in a separate subshell, use isProcessRunning "game.exe" to know if the process is still running.
8992
#}
90-
#onArchiveStart(){
91-
# code to be executed when using ./run.sh archive ...
93+
94+
#onArchiveStart() {
95+
# Code to be executed when using ./run.sh archive.
9296
#}
93-
#onArchiveEnd(){
94-
# code to be executed after archiving is done ...
97+
98+
#onArchiveEnd() {
99+
# Code to be executed after archiving is done.
95100
#}

0 commit comments

Comments
 (0)
Please sign in to comment.