Custom Content

From ETQWPro Wiki Pages

1 DESCRIPTION
2 HOW IT WORKS
3 USE CASES
4 CODE ASSUMPTIONS
5 USAGE
6 Credits and Source

DESCRIPTION

Enable automatic downloads of megatextures to connecting game clients. Finally permit a smooth ETQW public-mod auto-download experience!

HOW IT WORKS

The megatexture is copied/renamed into a .pk4 file on the server by server-admin or map-maker.
During map init, server tries to locate/reference the renamed megatexture, and if present causes it to be added to the .pk4 purelist, and hence automatically downloaded as part of the normal download system.
Client downloads .pk4 files and at the right time during map initialization, checks if the file is in .pk4, and if it is, extracts as nessesary, comparing checksums, as necessary. The megatexture is extracted to the mod's own folder.

USE CASES

The following client use cases were tested:

mega missing & pk4 missing
mega missing & pk4 exists/bad-checksum
mega missing & pk4 exists/good-checksum
mega exists/bad & pk4 missing
mega exists/bad & pk4 exists/bad
mega exists/bad & pk4 exists/good
mega exists/good & pk4 missing
mega exists/good & pk4 exists/bad
mega exists/good & pk4 exists/good

...which result in the following corresponding client actions:

download & extract
download & extract
extract
download & extract
download & extract
extract
download
download
nothing todo

CODE ASSUMPTIONS

The code hardcodes a filename convention for megatexture that is not guaranteed, so until the code is enhanced, the map as shipped must name its (extracted) MT file accordingly:

megatextures/<mapname>_lit.mega (EXTRACTED filename)
megatextures/<mapname>_lit.dat (ZIPPED filename)

USAGE

Create a supplemental .pk4 file adjacent to the .pk4 containing the new map filename .dat as shown above and place it on your server. The MT can be added to the map's primary .pk4 , it doesn't really matter. I did the following:

zpak_map_wake.pk4 (contains original files)
zpak_mega_wake.pk4 (contains only renamed megatexture file)

Where the content of zpak_mega_wake.pk4 is:

   Archive:  zpak_mega_wake.pk4
   Length   Method    Size  Ratio   Date   Time   CRC-32    Name
   --------  ------  ------- -----   ----   ----   ------    ----
          0  Stored        0   0%  02-08-08 05:13  00000000  megatextures/
    4905318  Defl:N  4869027   1%  02-08-08 04:13  67fe3d01  megatextures/wake_lit.dat
   --------          -------  ---                            -------
    4905318          4869027   1%                            2 files