c4f59a9ab30531e4e1d09fe72106df5d88c56bdc
[xonotic/xonotic.git] / misc / tools / xonotic-map-compiler
1 #!/usr/bin/perl
2
3 use strict;
4 use warnings;
5 use POSIX;
6 use File::Temp;
7
8 # change these to match your system, or define them in ~/.xonotic-map-compiler
9 # (just copy paste this part to the file ~/.xonotic-map-compiler)
10
11         # Path to Xonotic (where the data directory is in)
12         our $XONOTICDIR   = '/home/rpolzer/Games/Xonotic';
13
14         # Path to your q3map2 program. You find it in your GtkRadiant/install
15         # directory.
16         our $Q3MAP2      = '/home/rpolzer/Games/Xonotic/netradiant/install/q3map2.x86';
17
18         # General flags for q3map2 (for example -threads 4)
19         our $Q3MAP2FLAGS = '-fs_forbiddenpath xonotic-data.pk3 -fs_forbiddenpath xonotic-data.pk3dir -fs_forbiddenpath xonotic-nexcompat.pk3 -fs_forbiddenpath xonotic-nexcompat.pk3dir';
20
21         # Default flags for the -bsp stage
22         our $BSPFLAGS    = '-meta -maxarea -samplesize 8 -mv 1000000 -mi 6000000';
23
24         # Default flags for the -vis stage
25         our $VISFLAGS    = '';
26
27         # Default flags for the -light stage
28         our $LIGHTFLAGS  = '-lightmapsearchpower 3 -deluxe -patchshadows -randomsamples -samples 4 -lightmapsize 512 -fast -fastbounce -dirty -bouncegrid -fill';
29
30         # Default flags for the -minimap stage
31         our $MINIMAPFLAGS = '';
32
33         # Default order of commands
34         our $ORDER = 'vis,light';
35
36 # end of user changable part
37
38 do "$ENV{HOME}/.xonotic-map-compiler";
39
40 sub Usage()
41 {
42         print <<EOF;
43 Usage:
44 $0 mapname [-bsp bspflags...] [-vis visflags...] [-light lightflags...] [-minimap minimapflags]
45 EOF
46         exit 1;
47 }
48
49 my $options =
50 {
51         bsp => [split /\s+/, $BSPFLAGS],
52         vis => [split /\s+/, $VISFLAGS],
53         light => [split /\s+/, $LIGHTFLAGS],
54         minimap => [split /\s+/, $MINIMAPFLAGS],
55         scale => [], # can't have defaults atm
56         order => [split /\s*,\s*/, $ORDER],
57         maps => [],
58         scale => 1,
59         bsp_timeout => 0,
60         vis_timeout => 0,
61         light_timeout => 0,
62         minimap_timeout => 0,
63         scale_timeout => 0
64 };
65
66 my $curmode = 'maps';
67
68 while(@ARGV)
69 {
70         $_ = shift @ARGV;
71         my $enterflags = undef;
72         if($_ eq '-bsp')
73         {
74                 $enterflags = 'bsp';
75         }
76         elsif($_ eq '-vis')
77         {
78                 $enterflags = 'vis';
79         }
80         elsif($_ eq '-light')
81         {
82                 $enterflags = 'light';
83         }
84         elsif($_ eq '-minimap')
85         {
86                 $enterflags = 'minimap';
87         }
88         elsif($_ eq '-map')
89         {
90                 $curmode = 'maps';
91         }
92         elsif($_ eq '-scale')
93         {
94                 $options->{scale} = (shift @ARGV) || 1;
95                 #$enterflags = 'scale';
96         }
97         elsif($_ eq '-novis')
98         {
99                 $options->{vis} = undef;
100         }
101         elsif($_ eq '-nolight')
102         {
103                 $options->{light} = undef;
104         }
105         elsif($_ eq '-nominimap')
106         {
107                 $options->{minimap} = undef;
108         }
109         elsif($_ eq '-noshaderlist')
110         {
111                 $options->{noshaderlist} = 1;
112         }
113         elsif($_ eq '-bsp_timeout')
114         {
115                 $options->{bsp_timeout} = shift @ARGV;
116         }
117         elsif($_ eq '-vis_timeout')
118         {
119                 $options->{vis_timeout} = shift @ARGV;
120         }
121         elsif($_ eq '-light_timeout')
122         {
123                 $options->{light_timeout} = shift @ARGV;
124         }
125         elsif($_ eq '-minimap_timeout')
126         {
127                 $options->{minimap_timeout} = shift @ARGV;
128         }
129         elsif($_ eq '-scale_timeout')
130         {
131                 $options->{minimap_timeout} = shift @ARGV;
132         }
133         elsif($_ eq '-order')
134         {
135                 $options->{order} = [split /\s*,\s*/, shift @ARGV];
136         }
137         elsif($_ =~ /^--no(-.*)/)
138         {
139                 if($curmode eq 'maps')
140                 {
141                         $curmode = 'bsp';
142                 }
143                 my $flag = $1;
144                 @{$options->{$curmode}} = grep { (($_ eq $flag) ... /^-/) !~ /^[0-9]+$/ } @{$options->{$curmode}};
145                         # so, e.g. --no-samplesize removes "-samplesize" and a following "3"
146         }
147         elsif($_ =~ /^-(-.*)/)
148         {
149                 if($curmode eq 'maps')
150                 {
151                         $curmode = 'bsp';
152                 }
153                 push @{$options->{$curmode}}, $1;
154         }
155         elsif($_ =~ /^-/ and $curmode eq 'maps')
156         {
157                 $curmode = 'bsp';
158                 push @{$options->{$curmode}}, $_;
159         }
160         else
161         {
162                 push @{$options->{$curmode}}, $_;
163         }
164         if(defined $enterflags)
165         {
166                 $curmode = $enterflags;
167                 if($ARGV[0] eq '+')
168                 {
169                         shift @ARGV;
170                 }
171                 else
172                 {
173                         $options->{$curmode} = [];
174                 }
175         }
176 }
177
178 my $linkdir = File::Temp::tempdir("xonotic-map-compiler.XXXXXX", TMPDIR => 1, CLEANUP => 1);
179
180 sub q3map2(@)
181 {
182         my $mode = $_[0];
183         my $timeout = undef;
184         $timeout = $options->{bsp_timeout} if $mode eq '-bsp';
185         $timeout = $options->{vis_timeout} if $mode eq '-vis';
186         $timeout = $options->{light_timeout} if $mode eq '-light';
187         $timeout = $options->{minimap_timeout} if $mode eq '-minimap';
188         $timeout = $options->{scale_timeout} if $mode eq '-scale';
189         die "Invalid call: not a standard q3map2 stage" if not defined $timeout;
190         my @args = ($Q3MAP2, split(/\s+/, $Q3MAP2FLAGS), '-game', 'xonotic', '-fs_basepath', $XONOTICDIR, '-fs_basepath', $linkdir, '-v', @_);
191         print "\$ @args\n";
192         defined(my $pid = fork())
193                 or die "fork: $!";
194         if($pid) # parent
195         {
196                 local $SIG{ALRM} = sub { warn "SIGALRM caught\n"; kill TERM => $pid; };
197                 alarm $timeout
198                         if $timeout;
199                 if(waitpid($pid, 0) != $pid)
200                 {
201                         die "waitpid: did not return our child process $pid: $!";
202                 }
203                 alarm 0;
204                 return ($? == 0);
205         }
206         else # child
207         {
208                 exec @args
209                         or die "exec: $!";
210         }
211 }
212
213 (my $mapdir = getcwd()) =~ s!/[^/]*(?:$)!!;
214 $mapdir = "/" if $mapdir eq "";
215 symlink "$mapdir", "$linkdir/data";
216
217 my ($prescale, $postscale) = ($options->{scale} =~ /^([0-9.]+)(?::([0-9.]+))?$/);
218 $prescale = 1 if not defined $prescale;
219 $postscale = 1 if not defined $postscale;
220
221 for my $m(@{$options->{maps}})
222 {
223         $m =~ s/\.(?:map|bsp)$//;
224
225         if($prescale != 1)
226         {
227                 unshift @{$options->{bsp}}, "-keeplights";
228         }
229
230         my %shaders = map { m!/([^/.]*)\.shader(?:$)! ? ($1 => 1) : () } glob "../scripts/*.shader";
231
232         my $restore_shaderlist = sub { };
233         if(!$options->{noshaderlist})
234         {
235                 my $previous_shaderlist = undef;
236                 my $shaderlist = "";
237                 if(open my $fh, "<", "$XONOTICDIR/data/scripts/shaderlist.txt")
238                 {
239                         while(<$fh>)
240                         {
241                                 $shaderlist .= $_;
242                         }
243
244                         # we may have to restore the file on exit
245                         $previous_shaderlist = $shaderlist
246                                 if "$XONOTICDIR/data" eq $mapdir;
247                 }
248                 else
249                 {
250                         # possibly extract the shader list from a pk3?
251                         local $ENV{N} = $XONOTICDIR;
252                         $shaderlist = `cd "\$N" && for X in "\$N"/data/data*.pk3; do Y=\$X; done; unzip -p "\$Y" scripts/shaderlist.txt`;
253                 }
254
255                 my $shaderlist_new = "";
256                 for(split /\r?\n|\r/, $shaderlist)
257                 {
258                         delete $shaders{$_};
259                         $shaderlist_new .= "$_\n";
260                 }
261                 if(%shaders)
262                 {
263                         for(sort keys %shaders)
264                         {
265                                 $shaderlist_new .= "$_\n";
266                         }
267                 }
268                 else
269                 {
270                         $shaderlist_new = undef;
271                 }
272
273                 $restore_shaderlist = sub
274                 {
275                         if(defined $shaderlist_new)
276                         {
277                                 if(defined $previous_shaderlist)
278                                 {
279                                         open my $fh, ">", "$mapdir/scripts/shaderlist.txt";
280                                         print $fh $previous_shaderlist;
281                                         close $fh;
282                                 }
283                                 else
284                                 {
285                                         unlink "$mapdir/scripts/shaderlist.txt";
286                                 }
287                         }
288                 };
289
290                 if(defined $shaderlist_new)
291                 {
292                         mkdir "$mapdir/scripts";
293                         open my $fh, ">", "$mapdir/scripts/shaderlist.txt";
294                         print $fh $shaderlist_new;
295                         close $fh;
296                 }
297         }
298
299         local $SIG{INT} = sub
300         {
301                 print "SIGINT caught, cleaning up...\n";
302                 $restore_shaderlist->();
303                 exit 0;
304         };
305
306         eval
307         {
308                 unlink <$m/lm_*>; # delete old external lightmaps
309                 q3map2 '-bsp', @{$options->{bsp}},   "$m.map"
310                         or die "-bsp: $?";
311                 if($prescale != 1)
312                 {
313                         q3map2 '-scale', @{$options->{scale}}, $prescale, "$m.bsp"
314                                 or die "-scale: $?";
315                         rename "${m}_s.bsp", "$m.bsp"
316                                 or die "rename ${m}_s.bsp $m.bsp: $!";
317                 }
318                 my @o = @{$options->{order}};
319                 push @o, qw/light vis/;
320                 my %o = ();
321
322                 for(@o)
323                 {
324                         next if $o{$_}++;
325                         if($_ eq 'light')
326                         {
327                                 if(defined $options->{light})
328                                 {
329                                         q3map2 '-light',        @{$options->{light}}, "$m.map"
330                                                 or die "-light: $?";
331                                 }
332                         }
333                         if($_ eq 'vis')
334                         {
335                                 if(defined $options->{vis})
336                                 {
337                                         q3map2 '-vis',          @{$options->{vis}},   "$m.map"
338                                                 or die "-vis: $?";
339                                 }
340                         }
341                 }
342
343                 if($postscale != 1)
344                 {
345                         q3map2 '-scale', @{$options->{scale}}, $postscale, "$m.bsp"
346                                 or die "-scale: $?";
347                         rename "${m}_s.bsp", "$m.bsp"
348                                 or die "rename ${m}_s.bsp $m.bsp: $!";
349                 }
350
351                 if(defined $options->{minimap})
352                 {
353                         q3map2 '-minimap',      @{$options->{minimap}}, "$m.map"
354                                 or die "-minimap: $?";
355                 }
356
357                 unlink "$m.srf";
358                 unlink "$m.prt";
359
360                 $restore_shaderlist->();
361                 1;
362         }
363         or do
364         {
365                 $restore_shaderlist->();
366                 die $@;
367         };
368 }