File: README

package info (click to toggle)
maptransfer 0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 216 kB
  • ctags: 93
  • sloc: python: 817; makefile: 10
file content (42 lines) | stat: -rw-r--r-- 2,105 bytes parent folder | download | duplicates (2)
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
MapTransfer -- A tool to help lazy gameserver admins
====================================================

Has this ever happened to YOU? Having to upload yet another map from those
crazy clanmates of yours who keep downloading maps like their lives depend
on it? Having to open yet another SSH shell, for map in incoming/*; do unzip,
mv, cp, bzip2; done. It's boring. It's a total waste of time. It sucks ass.

MapTransfer tries to automate this process as much as possible. It handles
everything a map upload takes:

 * Finds the paths on the disk where Steam is installed and where games are
   located. (Uses the Registry on Windows, and maptransfer.cfg for other OSs)
 * BZips the Map before upload, and only uploads the BZ2ed file. That way,
   maps are automatically prepared for fast download, while saving (mega)bytes
   for the client to upload.
 * Uploads .nav/.txt/.res files, if any.
 * Hardlinks files on the server side, if more than one gameserver path is
   specified in the config; that way a single map is uploaded to multiple
   servers at once (and only takes up the space once, too).
 * Saves you and your users a lot of tedious cdery and copypasta.
 * Highlights the maps you or the server don't have, so you easily see what's
   missing on either side.

Aside from the core functionality, it offers a few niceties as well:

 * Client allows for simultaneous downloads and uploads.
 * Uses HTTPS as protocol - that way, you can download maps (or test
   connectivity) with your favorite web browser, or write your own scripts
   that interact with the server.
 * IPv6 ready
 * Extensible: Any game should work, as long as it uses bsp maps - map
   directories aren't hard coded but read from the config file.
 * Does not require *any* installation on Windows clients if using distutils,
   clients only need to unzip it somewhere and run client.exe.

Other notes:

 * Do use Python >=2.6. It will allow for a cleaner shutdown on the server,
   and the client will be able to use IPv6.
 * The server has only been tested on Linux, but I think it should work on
   other OSs as well.