Update Programming Tips
[xonotic/xonotic.wiki.git] / Automatic-map-downloads.md
1 # Automatic map downloads
2
3 ## Client-side configuration
4
5 Should already work without configuration. You can however use the following
6 cvars for further tuning (see xonotic.org/tools/cacs for more up-to-date information):
7
8 * `cl_curl_enabled`: download support enabled (master switch)
9 * `cl_curl_maxdownloads`: maximum number of downloads at once
10 * `cl_curl_maxspeed`: maximum total speed in KiB/s
11
12 Downloaded packages end up in `Xonotic/data/dlcache/` or
13 `~/.xonotic/data/dlcache/` and are only used till you exit Xonotic.
14  If you want to play them localy or use them to setup a server of your
15 own you can "accept" the packages by moving it one level up - right
16 next to your config.cfg.
17
18 You should regularily clean up your cache to save space and make the maps
19 you really want available from the menu.
20
21
22 ## Server-side configuration
23
24 First of all, you need a HTTP or FTP server to host your PK3s. You can either
25 use some web space provider, or set up your own. For this, use any FTP or HTTP
26 server software you want (HTTP: lighttpd, Apache, thttpd; FTP: Filezilla,
27 vsftpd). HTTP is to be preferred because it works better for firewalled
28 players.
29
30 On the server, you need to set up where to download the PK3s of the maps you
31 are running. You can either use the cvar:
32 * `sv_curl_defaulturl`           default download URL
33
34 to set it to some site, or put a file named "curl_urls.txt" in the data
35 directory of the following format:
36 ```
37    pattern        url
38    pattern        url
39    pattern        url
40    ...
41 ```
42 where always the first wildcard pattern match is taken.
43 ```
44    data*          -
45    strale*        http://stralemaps.invalid/
46    *              http://all.the.other.stuff.invalid/id/here.php?pak=
47    foo*           http://wont.get.here.invalid/
48 ```
49 The pk3 name will be appended to the URL by DarkPlaces. Note that you NEED to
50 append a trailing slash if you refer to a directory. If you specify a "-" as
51 URL, the package will not be offered for download.
52
53
54 INFORMATION FOR MIRROR/MAP SERVER ADMINS:
55
56 The Referer is always set to dp://serverhost:serverport/, the User-Agent
57 always starts with "Xonotic". Look at this sample log line:
58
59 141.2.16.3 - - [06/Jun/2006:19:43:14 +0000] "GET /~polzer/temp/nexmaps.php?filename=o-fun.pk3 HTTP/1.1" 302 - "dp://141.2.16.3:26000/" "Xonotic Linux 21:26:17 Jun  6 2006"
60
61
62 If you want to set up a redirection service, here is a sample PHP code for you
63 to start from:
64
65 ```
66 <?
67
68 function findmap($filename)
69 {
70     # insert your database query or whatever you want here
71     if($filename == "foo.pk3")
72         return "http://barserver.invalid/foo.pk3";
73     return FALSE;
74 }
75
76 function bailout($code, $title, $message)
77 {
78     header("HTTP/1.1 $code $title");
79     echo "<html><title>$title</title><h1>$title</h1>$message</html>";
80     exit(0);
81 }   
82
83 $filename = $_GET['filename'];
84
85 $useragent = getenv("HTTP_USER_AGENT");
86 if(strpos($useragent, "Xonotic ") !== 0)
87     bailout(403, "Forbidden", "You're not a Xonotic client.");
88     
89 $url = findmap($filename);
90 if(!$url)
91     bailout(404, "Not Found", "Well... try another file name?");
92     
93 header("HTTP/1.1 302 Moved Temporarily");
94 header("Location: $url");
95
96 ?>
97 ```