Skip to content

Commit 3bd9991

Browse files
committed
Updated documentation about new features and changes in v1.2.3, and added a tutorial about cs_trigger_roundstart.
1 parent e87d87d commit 3bd9991

File tree

64 files changed

+2720
-479
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+2720
-479
lines changed

docs/command-line-options.html

+50-16
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html>
33
<head>
44
<meta charset="utf-8">
5-
<title>3.2. Command-line options - MESS 1.2.2 documentation</title>
5+
<title>3.2. Command-line options - MESS 1.2.3 documentation</title>
66

77
<link rel="stylesheet" href="style.css">
88
<link rel="shortcut icon" href="images/mess_icon.png"/>
@@ -11,7 +11,7 @@
1111
<body>
1212
<div class="root-container">
1313
<nav>
14-
<h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
14+
<h1><a class="home-link" href="index.html">MESS 1.2.3</a></h1>
1515
<ul>
1616
<li>
1717
<a href="index.html">1. Getting started</a>
@@ -27,6 +27,7 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
2727
<li><a href="covering-terrain-advanced-template-selection.html">Covering terrain&colon; advanced template selection</a></li>
2828
<li><a href="covering-terrain-optimization.html">Covering terrain&colon; optimization</a></li>
2929
<li><a href="making-a-kill-counter-with-mtl_trigger_counter.html">Making a kill counter with mtl_trigger_counter</a></li>
30+
<li><a href="counter-strike-playing-a-different-song-each-round.html">Counter-Strike&colon; Playing a different song each round</a></li>
3031
<li><a href="creating-interactive-linked-groups-in-trenchbroom.html">Creating interactive linked groups in TrenchBroom</a></li>
3132
</ul>
3233
</li>
@@ -40,13 +41,15 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
4041
<li>
4142
<a href="template-entities.html">4. Template entities</a>
4243
<ul class="toc">
43-
<li><a href="mtl_env_model.html">4.1. mtl_env_model</a></li>
44-
<li><a href="mtl_trigger_area.html">4.2. mtl_trigger_area</a></li>
45-
<li><a href="mtl_trigger_counter.html">4.3. mtl_trigger_counter</a></li>
46-
<li><a href="mtl_trigger_periodic.html">4.4. mtl_trigger_periodic</a></li>
47-
<li><a href="mtl_trigger_random.html">4.5. mtl_trigger_random</a></li>
48-
<li><a href="mtl_trigger_sequence.html">4.6. mtl_trigger_sequence</a></li>
49-
<li><a href="cs_trigger_roundstart.html">4.7. cs_trigger_roundstart</a></li>
44+
<li><a href="mtl_env_model.html">mtl_env_model</a></li>
45+
<li><a href="mtl_trigger_area.html">mtl_trigger_area</a></li>
46+
<li><a href="mtl_trigger_counter.html">mtl_trigger_counter</a></li>
47+
<li><a href="mtl_trigger_periodic.html">mtl_trigger_periodic</a></li>
48+
<li><a href="mtl_trigger_random.html">mtl_trigger_random</a></li>
49+
<li><a href="mtl_trigger_sequence.html">mtl_trigger_sequence</a></li>
50+
<li><a href="mtl_trigger_switch.html">mtl_trigger_switch</a></li>
51+
<li><a href="cs_trigger_roundstart.html">cs_trigger_roundstart</a></li>
52+
<li><a href="q1_brush_text.html">q1_brush_text</a></li>
5053
</ul>
5154
</li>
5255
<li>
@@ -80,6 +83,12 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
8083
<li><a href="template-functions.html">7.5. Template functions</a></li>
8184
<li><a href="rewrite-rules.html">7.6. Rewrite rules</a></li>
8285
</ul>
86+
</li>
87+
<li>
88+
<a href="file-conversion.html">8. File conversion</a>
89+
<ul class="toc">
90+
<li><a href="convert-options.html">8.1. Convert options</a></li>
91+
</ul>
8392
</li>
8493

8594
</ul>
@@ -102,11 +111,17 @@ <h1 id="command-line-options">3.2. Command-line options</h1>
102111
<p>
103112
For additional settings, it's better to use <a href="configuration-files.html">configuration files</a>.</p>
104113
<h2 id="available-arguments">Available arguments</h2>
114+
<h3 id="modes:">Modes:</h3>
105115
<ul>
106116
<li>
107117
<a href="#-help">-help</a></li>
108118
<li>
119+
<a href="#-convert">-convert</a></li>
120+
<li>
109121
<a href="#-repl">-repl</a></li>
122+
</ul>
123+
<h3 id="settings:">Settings:</h3>
124+
<ul>
110125
<li>
111126
<a href="#-dir-path">-dir PATH</a></li>
112127
<li>
@@ -117,12 +132,23 @@ <h2 id="available-arguments">Available arguments</h2>
117132
<a href="#-vars-assignments">-vars ASSIGNMENTS</a></li>
118133
<li>
119134
<a href="#-globals-assignments">-globals ASSIGNMENTS</a></li>
135+
</ul>
136+
<h3 id="limits:">Limits:</h3>
137+
<ul>
120138
<li>
121139
<a href="#-maxrecursion-n">-maxrecursion N</a></li>
122140
<li>
123141
<a href="#-maxinstances-n">-maxinstances N</a></li>
124142
<li>
143+
<a href="#-norewrite">-norewrite</a></li>
144+
</ul>
145+
<h3 id="logging:">Logging:</h3>
146+
<ul>
147+
<li>
125148
<a href="#-log-log_level">-log LOG_LEVEL</a></li>
149+
</ul>
150+
<h3 id="arguments:">Arguments:</h3>
151+
<ul>
126152
<li>
127153
<a href="#input_path">INPUT_PATH</a></li>
128154
<li>
@@ -131,9 +157,14 @@ <h2 id="available-arguments">Available arguments</h2>
131157
<h2 id="-help"><code>-help</code></h2>
132158
<p>
133159
When this special argument is set, MESS will show a list of available arguments and then quit. All other arguments will be ignored.</p>
160+
<h2 id="-convert"><code>-convert</code></h2>
161+
<p>
162+
This switch enables file conversion mode. In this mode, map files can be converted to different formats. Supported formats are <code>.map</code> (both 'normal' and TrenchBroom files), <code>.rmf</code> (Hammer) and <code>.jmf</code> (J.A.C.K.). This mode also supports cordon areas and VIS group filtering. See <a href="file-conversion.html">File conversion</a> for more information.</p>
163+
<p>
164+
Use <code>-convert -help</code> to show a list of available arguments for the convert mode.</p>
134165
<h2 id="-repl"><code>-repl</code></h2>
135166
<p>
136-
This special argument enables the interactive MScript interpreter mode. This starts a REPL (read-evaluate-print loop) that can be used to try out MScript, the scripting language that is embedded in MESS. If this argument is set, then all other arguments will be ignored.</p>
167+
This switch enables the interactive MScript interpreter mode. This starts a REPL (read-evaluate-print loop) that can be used to try out MScript, the scripting language that is embedded in MESS. If this argument is set, then all other arguments will be ignored.</p>
137168
<p>
138169
While MScript is almost entirely expression-based, REPL mode supports assignments. For example, <code>a = 4 + 5</code> will store the result of the <code>4 + 5</code> expression in the variable named <code>a</code>. For convenience, the latest evaluation result is also stored in a special variable named <code>_</code>.</p>
139170
<p>
@@ -153,12 +184,12 @@ <h2 id="-config-path"><code>-config PATH</code></h2>
153184
<h2 id="-fgd-path">-<code>fgd PATH</code></h2>
154185
<p>
155186
This overrides the <code>mess.fgd</code> file path setting from the current configuration file. See <a href="configuration-files.html#fgd-path">configuration file: fgd-path</a> for more information.</p>
156-
<h2 id="-vars-"assignments""><code>-vars "ASSIGNMENTS"</code></h2>
187+
<h2 id="-vars-assignments"><code>-vars "ASSIGNMENTS"</code></h2>
157188
<p>
158189
These variables will be available in MScript expressions in the map properties and top-level entities of the input map. The input format is <code>"name1 = expression; name2 = expression;"</code>, and so on.</p>
159190
<p>
160191
These variables are added to the ones from the current configuration file. If multiple variables with the same name are specified, then the last value wins. Variables provided via the command-line always overwrite variables from the configuration file if they have the same name. See <a href="configuration-files.html#variables">configuration file: variables</a> for more information.</p>
161-
<h2 id="-globals-"assignments""><code>-globals "ASSIGNMENTS"</code></h2>
192+
<h2 id="-globals-assignments"><code>-globals "ASSIGNMENTS"</code></h2>
162193
<p>
163194
Global variables are available in MScript expressions anywhere, via the <code>getglobal</code>, <code>setglobal</code> and <code>useglobal</code> functions. Unlike variables, which are only available in the map properties and in top-level entities, globals are also available inside templates and template maps. The input format is <code>"name1 = expression; name2 = expression;"</code>, and so on.</p>
164195
<p>
@@ -169,23 +200,26 @@ <h2 id="-maxrecursion-n"><code>-maxrecursion N</code></h2>
169200
<h2 id="-maxinstances-n"><code>-maxinstances N</code></h2>
170201
<p>
171202
This overrides the maximum instances setting from the current configuration file. See <a href="configuration-files.html#max-instances">configuration file: max-instances</a> for more information.</p>
203+
<h2 id="-norewrite"><code>-norewrite</code></h2>
204+
<p>
205+
This disables rewrite rules. Without rewrite rules, template entities won't be rewritten to macro entities, and template behaviors won't be applied, so this setting is mostly for testing and debugging.</p>
172206
<h2 id="-log-log_level"><code>-log LOG_LEVEL</code></h2>
173207
<p>
174208
This overrides the log level setting from the current configuration file. Available log levels are <code>off</code>, <code>minimal</code>, <code>error</code>, <code>warning</code>, <code>info</code> (the default level) and <code>verbose</code>. See <a href="configuration-files.html#log-level">configuration file: log-level</a> for more information.</p>
175209
<h2 id="input_path"><code>INPUT_PATH</code></h2>
176210
<p>
177-
This specifies the map file that must be processed by MESS. Supported formats are <code>.map</code>, <code>.rmf</code> and <code>.jmf</code>. The output format is always <code>.map</code>. This argument must come after all the other arguments (but before <code>OUTPUT_PATH</code>).</p>
211+
This specifies the map file that must be processed by MESS. Supported formats are: <code>.map</code>, <code>.rmf</code> and <code>.jmf</code>. This argument must come after all the other arguments (but before <code>OUTPUT_PATH</code>).</p>
178212
<p>
179-
If the input file is a <code>.map</code> file and if no output path is set, then the input file will be overwritten.</p>
213+
If the input file is a <code>.map</code> file and if no output path is set, then the input file will be overwritten. If the input file is a different format and if no output path is set, then a <code>.map</code> file with the same name as the input file will be created.</p>
180214
<h2 id="output_path"><code>OUTPUT_PATH</code></h2>
181215
<p>
182-
This tells where MESS will save the resulting map file. Specifying a custom output path is useful if you want to prevent MESS from overwriting the input file. This argument must come after all the other arguments.</p>
216+
This tells where MESS will save the resulting map file. Specifying a custom output path is useful if you want to prevent MESS from overwriting the input file. This argument must come after all the other arguments. Supported formats are: <code>.map</code>, <code>.rmf</code> and <code>.jmf</code>.</p>
183217

184218
</article>
185219
</main>
186220

187221
<footer>
188-
© copyright 2023, Pieter Witvoet
222+
© copyright 2024, Pieter Witvoet
189223
</footer>
190224
</div>
191225
</div>

docs/configuration-files.html

+19-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html>
33
<head>
44
<meta charset="utf-8">
5-
<title>3.1. Configuration files - MESS 1.2.2 documentation</title>
5+
<title>3.1. Configuration files - MESS 1.2.3 documentation</title>
66

77
<link rel="stylesheet" href="style.css">
88
<link rel="shortcut icon" href="images/mess_icon.png"/>
@@ -11,7 +11,7 @@
1111
<body>
1212
<div class="root-container">
1313
<nav>
14-
<h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
14+
<h1><a class="home-link" href="index.html">MESS 1.2.3</a></h1>
1515
<ul>
1616
<li>
1717
<a href="index.html">1. Getting started</a>
@@ -27,6 +27,7 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
2727
<li><a href="covering-terrain-advanced-template-selection.html">Covering terrain&colon; advanced template selection</a></li>
2828
<li><a href="covering-terrain-optimization.html">Covering terrain&colon; optimization</a></li>
2929
<li><a href="making-a-kill-counter-with-mtl_trigger_counter.html">Making a kill counter with mtl_trigger_counter</a></li>
30+
<li><a href="counter-strike-playing-a-different-song-each-round.html">Counter-Strike&colon; Playing a different song each round</a></li>
3031
<li><a href="creating-interactive-linked-groups-in-trenchbroom.html">Creating interactive linked groups in TrenchBroom</a></li>
3132
</ul>
3233
</li>
@@ -40,13 +41,15 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
4041
<li>
4142
<a href="template-entities.html">4. Template entities</a>
4243
<ul class="toc">
43-
<li><a href="mtl_env_model.html">4.1. mtl_env_model</a></li>
44-
<li><a href="mtl_trigger_area.html">4.2. mtl_trigger_area</a></li>
45-
<li><a href="mtl_trigger_counter.html">4.3. mtl_trigger_counter</a></li>
46-
<li><a href="mtl_trigger_periodic.html">4.4. mtl_trigger_periodic</a></li>
47-
<li><a href="mtl_trigger_random.html">4.5. mtl_trigger_random</a></li>
48-
<li><a href="mtl_trigger_sequence.html">4.6. mtl_trigger_sequence</a></li>
49-
<li><a href="cs_trigger_roundstart.html">4.7. cs_trigger_roundstart</a></li>
44+
<li><a href="mtl_env_model.html">mtl_env_model</a></li>
45+
<li><a href="mtl_trigger_area.html">mtl_trigger_area</a></li>
46+
<li><a href="mtl_trigger_counter.html">mtl_trigger_counter</a></li>
47+
<li><a href="mtl_trigger_periodic.html">mtl_trigger_periodic</a></li>
48+
<li><a href="mtl_trigger_random.html">mtl_trigger_random</a></li>
49+
<li><a href="mtl_trigger_sequence.html">mtl_trigger_sequence</a></li>
50+
<li><a href="mtl_trigger_switch.html">mtl_trigger_switch</a></li>
51+
<li><a href="cs_trigger_roundstart.html">cs_trigger_roundstart</a></li>
52+
<li><a href="q1_brush_text.html">q1_brush_text</a></li>
5053
</ul>
5154
</li>
5255
<li>
@@ -80,6 +83,12 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
8083
<li><a href="template-functions.html">7.5. Template functions</a></li>
8184
<li><a href="rewrite-rules.html">7.6. Rewrite rules</a></li>
8285
</ul>
86+
</li>
87+
<li>
88+
<a href="file-conversion.html">8. File conversion</a>
89+
<ul class="toc">
90+
<li><a href="convert-options.html">8.1. Convert options</a></li>
91+
</ul>
8392
</li>
8493

8594
</ul>
@@ -207,7 +216,7 @@ <h2 id="inverted-pitch-predicate"><code>inverted-pitch-predicate</code></h2>
207216
</main>
208217

209218
<footer>
210-
© copyright 2023, Pieter Witvoet
219+
© copyright 2024, Pieter Witvoet
211220
</footer>
212221
</div>
213222
</div>

docs/configuration.html

+19-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html>
33
<head>
44
<meta charset="utf-8">
5-
<title>3. Configuration - MESS 1.2.2 documentation</title>
5+
<title>3. Configuration - MESS 1.2.3 documentation</title>
66

77
<link rel="stylesheet" href="style.css">
88
<link rel="shortcut icon" href="images/mess_icon.png"/>
@@ -11,7 +11,7 @@
1111
<body>
1212
<div class="root-container">
1313
<nav>
14-
<h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
14+
<h1><a class="home-link" href="index.html">MESS 1.2.3</a></h1>
1515
<ul>
1616
<li>
1717
<a href="index.html">1. Getting started</a>
@@ -27,6 +27,7 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
2727
<li><a href="covering-terrain-advanced-template-selection.html">Covering terrain&colon; advanced template selection</a></li>
2828
<li><a href="covering-terrain-optimization.html">Covering terrain&colon; optimization</a></li>
2929
<li><a href="making-a-kill-counter-with-mtl_trigger_counter.html">Making a kill counter with mtl_trigger_counter</a></li>
30+
<li><a href="counter-strike-playing-a-different-song-each-round.html">Counter-Strike&colon; Playing a different song each round</a></li>
3031
<li><a href="creating-interactive-linked-groups-in-trenchbroom.html">Creating interactive linked groups in TrenchBroom</a></li>
3132
</ul>
3233
</li>
@@ -40,13 +41,15 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
4041
<li>
4142
<a href="template-entities.html">4. Template entities</a>
4243
<ul class="toc">
43-
<li><a href="mtl_env_model.html">4.1. mtl_env_model</a></li>
44-
<li><a href="mtl_trigger_area.html">4.2. mtl_trigger_area</a></li>
45-
<li><a href="mtl_trigger_counter.html">4.3. mtl_trigger_counter</a></li>
46-
<li><a href="mtl_trigger_periodic.html">4.4. mtl_trigger_periodic</a></li>
47-
<li><a href="mtl_trigger_random.html">4.5. mtl_trigger_random</a></li>
48-
<li><a href="mtl_trigger_sequence.html">4.6. mtl_trigger_sequence</a></li>
49-
<li><a href="cs_trigger_roundstart.html">4.7. cs_trigger_roundstart</a></li>
44+
<li><a href="mtl_env_model.html">mtl_env_model</a></li>
45+
<li><a href="mtl_trigger_area.html">mtl_trigger_area</a></li>
46+
<li><a href="mtl_trigger_counter.html">mtl_trigger_counter</a></li>
47+
<li><a href="mtl_trigger_periodic.html">mtl_trigger_periodic</a></li>
48+
<li><a href="mtl_trigger_random.html">mtl_trigger_random</a></li>
49+
<li><a href="mtl_trigger_sequence.html">mtl_trigger_sequence</a></li>
50+
<li><a href="mtl_trigger_switch.html">mtl_trigger_switch</a></li>
51+
<li><a href="cs_trigger_roundstart.html">cs_trigger_roundstart</a></li>
52+
<li><a href="q1_brush_text.html">q1_brush_text</a></li>
5053
</ul>
5154
</li>
5255
<li>
@@ -80,6 +83,12 @@ <h1><a class="home-link" href="index.html">MESS 1.2.2</a></h1>
8083
<li><a href="template-functions.html">7.5. Template functions</a></li>
8184
<li><a href="rewrite-rules.html">7.6. Rewrite rules</a></li>
8285
</ul>
86+
</li>
87+
<li>
88+
<a href="file-conversion.html">8. File conversion</a>
89+
<ul class="toc">
90+
<li><a href="convert-options.html">8.1. Convert options</a></li>
91+
</ul>
8392
</li>
8493

8594
</ul>
@@ -105,7 +114,7 @@ <h2 id="configuration-sources">Configuration sources</h2>
105114
</main>
106115

107116
<footer>
108-
© copyright 2023, Pieter Witvoet
117+
© copyright 2024, Pieter Witvoet
109118
</footer>
110119
</div>
111120
</div>

0 commit comments

Comments
 (0)