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/11/26 18:47] – [Hosting] ZigguratVertigoBlewTronynsSocksOff! Spirit | help:how_to_package_and_release_a_file [2020/02/20 18:37] – [Hosting] human[rus] | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== How to package and release a file ===== | ===== How to package and release a file ===== | ||
- | <WRAP center round todo 60%> | + | ==== Naming ==== |
- | This is work in progress | + | |
- | </ | + | |
+ | === Map === | ||
- | ==== Naming | + | ==== Text file ==== |
- | === Maps === | ||
- | 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 " | ||
- | Don't forget | + | 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 |
- | === Mods === | + | ================================================================ |
- | 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. | + | BASE FILE FOR CUSTOM LEVELS |
- | === Examples of good naming schemes === | + | Title : |
- | * efdatsp1.bsp - The Place of Dismay by efdat, full nickname since it is short & sp & number | + | |
- | * 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 === | + | Filename |
- | 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. | + | Author(s) |
- | Before you settle, search the web for the name and make sure it is not already used. | + | Email Address |
- | ==== readme.txt ==== | + | Description |
- | 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 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: [[/ | ||
- | 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 have creativity oozing out your pores, well, some mappers include erotic short 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 feel like you must use a more modern and smaller format, use the free format 7z. But seriously, please don't. Only even think about this if you want to release a huge amount of files and using 7z would considerably reduce the file size. | + | Deathmatch 2-32 Player |
- | 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. | + | .map |
- | 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 | + | Software needed |
- | 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. | + | Comments |
+ | |||
+ | * Construction * | ||
+ | |||
+ | |||
+ | Build Time : | ||
+ | |||
+ | Times & stats : | ||
+ | |||
+ | System Used : | ||
+ | |||
+ | Editor(s) used : | ||
+ | |||
+ | |||
+ | |||
+ | ==== Packaging ==== | ||
+ | zip | ||
==== Hosting ==== | ==== Hosting ==== | ||
If it is a finished work, you can contact [[quaddicted.com: | If it is a finished work, you can contact [[quaddicted.com: | ||
- | If that is not an option, if it is a work-in-progress, | + | If that is not an option, if it is a work-in-progress, |
+ | |||
+ | For permanent hosting you can also freely use https:// | ||
+ | |||
+ | Do not use services that do not support direct download links. And please do not use volatile hosts like Dropbox, Google Drive or any ad-financed free hosting providers. |