MeatROme | 2006-05-14 12:27
HOW-TO : package content for Quadropolis

Are you planning to upload some content to Quadropolis - Great! Read on!

To avoid comments like

  • "Where do I put this?" and/or
  • "There's a "texture missing" error ..." and/or
  • "Why are so many walls not textured?" and/or
  • "Why can't I hear the music?" and/or
  • "Please fix your node!"

you should adhere to the following guidelines.

The examples are fitted for sauerbraten content,
the other games are sufficiently similar, or will be commented on in appropriate sections.

The Cube Wiki article Distributing Maps contains the original text of this guide;
I am now only going to add a few notes about Quadropolis postings here.

Content
  1. Quadropolis Nodes
  2. Use ZIP files
  3. correct ZIPping
  4. Make a good screenshot
  5. Have a README
  6. Beware of OS caveats

Quadropolis Nodes

Quadropolis uses a number of paradigms to serve differently formatted media-packages for Cube Engine games of a number of flavours;

The top-level paradigm "node" is wether your media is a Map - this might need to include more than the actual *.cgz, *.ogz or whatever extension your MOD uses, actually - or wether it's a MOD - that might mean anything from some basic content modding up to a full-blown total-conversion - or if it's a Script addon.
The Scripts currently might need to refactored .. actually thought for CubeScript only there's a number of early nodes there that should be MODs (e.g. the map-menu generator) ... please put non-CubeScript scripts into MODs yourself, thanks!

The node paradigm results in a type-specific container which will hold a number of attributes.
So you will want to present users with a screenshot of your map or mod .. but traditionally scripts don't have one.
maps will want to be categorized by the different gamemodes (e.g. a Capture-only map or even a gamemode only available in a quadropolis supported mod (e.g. CTF for AC)), or size (for 4 players, 16 players ..).
A mod will need to flag the operating-systems it's for.
Please take care when filling out the form for an upload - incorrect settings here are often reason for complaint, really pick the right choice/choices for each field! Especially Licensing has repeatedly been assigned incorrect values.

Don't forget to check display of your new node, e.g. after having logged out .. to see it's showing up everything;
you can always click on "edit" when viewing nodes you posted (of course being logged in again),
and fix up any or all the field settings .. if you want to update your node with a new file for example :)

Use ZIP files

Even if it's just a single map!
Do not use any other packaging software; ZIP is universally available.

Always package content so that it can be extracted directly into the installation folder;
this explains why even a single map file should be zipped (they should be in the subfolder packages/base/ inside the ZIP (or equivalent for non-sauerbraten games))... maybe the only exception to this zipping rule would be a very simple script - one that will either be called directly from autoexec.cfg (or even be copied into it), since they would best be placed directly in the installation folder anyway.

Don't replace content! There is always a way to make your content sit side-by-side with the regular stuff,
if you actually do need to replace stuff (models come to mind) then just add information about how to switch to and fro in your README.

correct ZIPping

Remove all cruft from it too before uploading, just the content and a readme should be in it.
Don't include any hidden files of your system ... like those Windows and MacOS like to create - but *Nix users should watch out too! Remove them from the ZIP-file after zipping if you can't prevent them from going in in the first place. Also do not name your ZIP-file packages.zip.

For MacOS the following program was once mentioned on the forum - but I have not heard any feedback about it - clean archive.
Halleck has told me about MacZipIt, which seems to work well via simple drag-n-drop.
MovingTarget found this article about dot_clean in the hope Mac users will find it useful.

On Windows XP (or later) ZIP is integrated into your FileManager (Explorer).
Unless you're using a more elaborate GUI capable of compressing into classic WinZIP format I'd suggest the following procedure to create a clean upload:

Create a folder for your download - imagine this to be the folder sauerbraten is installed into;
place a README_theFileName.[html/txt] into this folder.
Depending on what you are distributing you should add appropriate subfolders like packages/theFileName or packages/base and/or whatever needs to be added to a vanilla sauerbraten installation to use your upload.
When everything is in place go to the folder with your README and mark everything (Ctrl + A),
then right-click on the README and "send to ZIP-compressed folder".

On linux I can recommend using a file with a line for each part to be included in the zip and then
calling something like zip -r my_upload.zip -i@my_files ./ from the installation folder.

Your ZIP should be structured something like this:
ZIPstructuredEXAMPLE
or see a fully expanded version.

Make a good screenshot

For content nodes that require a screenshot please take some care in creating it.

Take a look at the subline of the screenshot-form-element in the upload-form to see current limitations,
at the time of writing these were 1024 KB maximum file-size and 640x480 maximum dimensions.

JPG or PNG should be the formats of choice and reducing file-size as much as possible a courtesy to the community :)

Consider using the Pretty Screenshot script to avoid ugly output as well as the HUD and hudgun to clutter that extra nice viewpoint you've chosen for your map.
To shoot from angles where you can't stand on geometry consider switching to gamespeed 10 - that way you don't get the editmode stuff on your screenie ;)

The regular screenshot is usually too dark,
consider using channel-mixing techniques to enhance the image so it shows up better!

Ingame settings can also enhance your screenshots - e.g. fullscreen shaders (bloom, ..), FOV but not gamma!

Have a README

It's always a good idea to include a readme, usually named something like README_mycontent001.txt;
place information in there about creation date, contact information (nice-to-have not must-have) and
anything pertaining to how to use your work with the engine.

Beware of OS caveats

You should be aware that not everyone out there is running the same OS (operating system) as you are.
Especially variations on upper-/lowercase can be a problem here,
even if your Windows loads the textures fine with the file being image.JPG but the map-CFG loading IMAGE.jpg - it won't work on systems that are aware of case in their filenames (Unix, Linux, Mac OS X, ...) - your safest bet is to always go for lowercase filenames ... and check the extensions (some systems blend them out by default).
Another pitfall can be using weird characters in your filenames - even spaces can be quirksome - please avoid them.

User login
41
points ]
 (5 votes)
Created 2010-03-10 15:03
1 day 10 hours ago
10
points ]
 (1 vote)
Created 2010-03-10 22:39
1 day 3 hours ago
Created 2010-03-11 15:26
10 hours 18 min ago
Greaserpirate
Created 2010-03-12 00:26
1 hour 18 min ago
mhelenurm
43
points ]
 (6 votes)
Created 2010-02-24 19:59
2 weeks 1 day ago
suicizer01
64
points ]
 (8 votes)
Created 2010-03-07 14:52
4 days 10 hours ago
276
points ]
 (33 votes)
Created 2008-05-25 05:49
1 year 41 weeks ago
4
points ]
 (1 vote)
Created 2010-03-10 21:18
1 day 4 hours ago
95
points ]
 (11 votes)
Created 2010-02-21 19:05
2 weeks 4 days ago
61
points ]
 (7 votes)
Created 2010-02-27 17:19
1 week 5 days ago
15
points ]
 (2 votes)
Created 2010-02-28 00:13
1 week 5 days ago
374
points ]
 (39 votes)
Created 2009-07-26 22:32
32 weeks 4 days ago
2
points ]
 (1 vote)
Created 2010-02-25 05:53
2 weeks 19 hours ago
56
points ]
 (8 votes)
Created 2010-03-06 15:08
5 days 10 hours ago
Chillpill
6
points ]
 (2 votes)
Created 2010-03-07 21:54
4 days 3 hours ago
20
points ]
 (2 votes)
Created 2010-03-01 21:02
1 week 3 days ago
14
points ]
 (5 votes)
Created 2009-01-16 03:25
1 year 7 weeks ago
20
points ]
 (2 votes)
Created 2010-03-07 12:41
4 days 13 hours ago
30
points ]
 (3 votes)
Created 2010-02-18 22:58
3 weeks 2 hours ago
mIscreant
34
points ]
 (4 votes)
Created 2010-02-25 07:54
2 weeks 17 hours ago
Users on Quadropolis
5 guests & 2 users online