mod-manager/complete.example.toml at master · Lucki/mod-manager · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#:schema https://github.com/Lucki/mod-manager/raw/refs/heads/master/schema-config-game.json

############################## required ##############################

# The absolute path to the game folder, the original game files without any mods.
# This can be optional when "game_root_path" is set in "config.toml", see "config.example.toml" for details.
path = "/mnt/big data/my game"

############################## optional ##############################
# In the following lines, "<gameID>" is the basename of this toml configuration file (<gameID>.toml)

# Defines the default mod set to activate.
# Can be overridden from the command line with --set <modID>
# An empty or missing value results into a a game without any mods.
# The same is applies when called with --set ""
# See below for the "[set1]" table example.
active = "set1"

# Defines the search location for mods.
# default: "$XDG_DATA_HOME/mod-manager/<gameID>"
# Can also be declared in "config.toml", see "config.example.toml" for details.
mod_root_path = "/mnt/big data/mods/my game"

# Sets if the game file folder can be written into.
# If this is true, the changes made will be saved in "$XDG_CACHE_HOME/mod-manager/<gameID>/<modID>_persistent"
# Defaults to false.
writable = true

# This sets whether or not the "pre_command" table should be started after applying any mod set.
# See below for "[[pre_command]]" table examples.
# Defaults to false.
run_pre_command = true

######################################################################
#                  Basic mod set example                             #
######################################################################

# Set identifier
# Required, because referenced in "active" above
["set1"]

# Sets if the game file folder can be written into.
# If this is true, the changes made will be saved in "$XDG_CACHE_HOME/mod-manager/<gameID>/<modID>_persistent"
# Defaults to false.
writable = true

# Mods array containing all mods, that are applied with this mod set.
# Each mod is expected to be found in the "mod_root_path", see above.
# Mods, that are lower in the listing below, are less prioritized
# Example: When two mods include the same file, only the upper one will be seen by the game
mods = [
    "mod1", # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/mod1"
    "mod2", # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/mod2"
    "mod3", # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/mod3"
]

######################################################################
#                  Advanced mod set example                          #
######################################################################

# Set identifier
["everything"]

# Mods array containing all mods, that are applied with this mod set.
# Each mod is expected to be found in the "mod_root_path", see above.
# Mods, that are lower in the listing below, are less prioritized
# Example: When two mods include the same file, only the upper one will be seen by the game
# Sets can be nested - beware you don't create an infinite loop!
mods = [
    "mod1",                # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/mod1"
    "Visual Enhancements", # ID of a set which is defined below as ["Visual Enhancements"]
    "mod2",                # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/mod2"
]

# Set identifier
["Visual Enhancements"]

# Defines that the [[pre_commands]] should be run.
# Identical to the global option above, but only applies when this mod set is in use.
# Defaults to false
run_pre_command = true

# Defines a custom command for this mod set. See below for the ["my_special_command"] example.
command = "my_special_command"

# Mods array containing all mods, that are applied with this mod set.
# Each mod is expected to be found in the "mod_root_path", see above.
# Mods, that are lower in the listing below, are less prioritized
# Example: When two mods include the same file, only the upper one will be seen by the game
# Sets can be nested - beware you don't create an infinite loop!
mods = [
    "4k Textures",   # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/4k Textures"
    "Sunny weather", # This folder has to exist: "$XDG_DATA_HOME/mod-manager/<gameID>/Sunny weather"
]

# Additional environment variables for a wrapped command as a sub table in the form of:
# VARIABLE = "value"
["Visual Enhancements".environment]
WINEDLLOVERRIDES = "winhttp=n,b"
MY_ENV = "variable"

# An array of pre_commands, can appear multiple times.
# Defines commands that will run after applying the mod, but only if any mod set or the global option has "run_pre_command" set to true
[[pre_command]]

# Sets if the command should be waited for, before continuing
# Defaults to true
wait_for_exit = false

# If there should be waiting time after this command, before continuing to the next.
# Defaults to 0
delay_after = 60

# The actual command to use as an array of strings.
# Shell variables like "~" or "$XDG_DATA_HOME" aren't available here.
command = ["wine", "my-pre-command.exe", "--path", "/asd/asd/asd"]

# Run this command in a different working directory
working_directory = "/mnt/big data/my game/~mods"

# Additional environment variables for the command as a sub table in the form of:
# VARIABLE = "value"
[pre_command.environment]
WINEPREFIX = "/path/to/prefix"
MY_ENV = "variable"

# An array of pre_commands, can appear multiple times.
# Defines commands that will run after applying the mod, but only if any mod set or the global option has "run_pre_command" set to true
[[pre_command]]

# The actual command to use as an array of strings.
# Shell variables like "~" or "$XDG_DATA_HOME" aren't available here.
command = [
    "bottles-cli",
    "run",
    "--bottle='my-bottle'",
    "--program='my-program'",
]

# Run this command in a different working directory
working_directory = "/mnt/big data/my game/~mods"

# Additional environment variables for the command as a sub table in the form of:
# VARIABLE = "value"
[pre_command.environment]
MY_ENV = "variable2"

# Specific referenced commands are placed in the subtable "commands".
[commands."my_special_command"]

# Sets if the command should be waited for, before continuing
# Defaults to true
wait_for_exit = false

# If there should be waiting time after this command, before continuing to the next.
# Defaults to 0
delay_after = 60

# The actual command to use as an array of strings.
# Shell variables like "~" or "$XDG_DATA_HOME" aren't available here.
command = ["wine", "my-pre-command.exe", "--yes"]

# Run this command in a different working directory
working_directory = "/mnt/big data/my game/~mods"

# Additional environment variables for the command as a sub table in the form of:
# VARIABLE = "value"
[commands."my_special_command".environment]
WINEPREFIX = "/path/to/prefix"
MY_ENV = "variable"