Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
help:how_to_package_and_release_a_file [2017/12/23 08:29] – updates Spirit | help:how_to_package_and_release_a_file [2020/02/20 18:36] – [Packaging] human[rus] | ||
---|---|---|---|
Line 3: | Line 3: | ||
==== Naming ==== | ==== Naming ==== | ||
- | === Maps === | + | === Map === |
- | Pick a good filename for your .bsp file. People commonly use their nicknames and a counter or try to find a good short word describing the map. Adding a " | + | |
- | Alternatively just name it after the map's actual name. | + | ==== Text file ==== |
- | Don't forget to set the title field in the .bsp file to something useful. | ||
- | === Mods === | + | You must add a text file to your release, documenting at least the title of the work and your (nick)name. create date: 20-20-2020 |
- | For mods the standard seems to be a more descriptive filename. Usually it is a short form of the mod's title. If it is a mod just supporting one map (so it's more of a map than a mod) the map naming suggestions above apply though. | + | |
- | === Examples of good naming schemes | + | ================================================================ |
- | * efdatsp1.bsp - The Place of Dismay by efdat, full nickname since it is short & sp & number | + | BASE FILE FOR CUSTOM LEVELS |
- | * chessp1.bsp - Shrine of Skank by cheshire, abbreviated nickname & sp & number | + | |
- | * ikspq1.bsp - Before Nightfall by Iikka " | + | |
- | * ac.bsp - Adamantine Cruelty by Vondur, acronym of the level title | + | |
- | * ant.bsp - Antediluvian by metlslime, abbreviated title | + | |
- | * cogs.bsp - Cogs Of Conflict by spd, a single prominent word from the title | + | |
- | === General considerations === | + | Title : |
- | Be aware that filenames longer than 8 characters will be a pain to use on DOS. So if you are a nice person, find a short one. It will also be nicer to type (if the user's engine does not support tab completion). | + | |
- | Avoid any characters that are not a-z or 0-9. A single dash - might be ok. Quake engines do not handle international keyboard layouts well. Do not use uppercase characters for any files. | + | Filename |
- | Before you settle, search the web for the name and make sure it is not already used. | + | Author(s) |
- | ==== Text file ==== | + | Email Address |
- | You must add a text file to your release, documenting at least the title of the work and your (nick)name. You should also include a release name, the intended purpose, contact details, release date and the like. Without this, your file(s) might be lost in "who on earth made this and when and why?!" limbo. | + | |
- | Best practice would be using the good old base.txt template: [[/ | + | Description |
- | Name the text file exactly like your zip file and/or your bsp file and/or your mod directory! For example the readme file for abc123.bsp would be abc123.txt. For the mod qwe456/ the readme file would be named qwe456.txt and placed into qwe456/ : qwe456/ | ||
- | If you name your text file readme.txt, it will conflict with everyone else's same-named file and no one wants to overwrite other people' | + | ============================================================== |
- | If you have creativity oozing out your pores, well, some mappers include short background stories too. | + | Single Player |
- | ==== Packaging ==== | + | Cooperative 1-32 Player : |
- | Package your files into a standard zip archive. Not rar, not a self-extracting exe, just a plain zip. Zip is widely supported, Windows natively can handle the format since Windows XP. MacOS and Linux have no trouble either. | + | |
- | If you release a single file, put it (and its readme) directly into the zip file. Do not add a directory. If the user extracts the file straight into his maps/ directory, it should be correct. | + | Deathmatch 2-32 Player |
- | If you release a mod, put a directory into the zip file so if the user extracts the zip into his Quake directory, the mod will be properly installed. Remember to mind the character rules, lowercase only, a-z and 0-9, no special characters except maybe - and no spaces whatsoever. Put all your files inside that directory. | + | .map |
- | If you are releasing a single file, name the zip the same as the file. For example abc123.zip would be the archive for abc123.bsp and abc123.txt. If you release a mod, try to do the same. | + | Software needed |
- | ==== Hosting ==== | + | Comments |
- | If it is a finished work, you can contact [[quaddicted.com:Spirit]] to get it hosted at Quaddicted. Feel free to mail it straightaway. | + | |
- | If that is not an option, if it is a work-in-progress, | + | * Construction * |
+ | |||
+ | |||
+ | Build Time : | ||
+ | |||
+ | Times & stats : | ||
+ | |||
+ | System Used : | ||
+ | |||
+ | Editor(s) used : | ||
+ | |||
+ | |||
+ | |||
+ | ==== Packaging ==== | ||
+ | zip | ||
+ | |||
+ | ==== Hosting ==== | ||
+ | https://archive.org/download/ |