Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
help:how_to_package_and_release_a_file [2013/02/14 13:56] – created Spirit | help:how_to_package_and_release_a_file [2023/02/14 16:47] (current) – [Hosting] Spirit | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== How to package and release a file ===== | ===== How to package and release a file ===== | ||
- | <WRAP center round todo 60%> | + | dumptruck_ds made a [[https:// |
- | This is work in progress | + | |
- | </WRAP> | + | |
+ | ==== Naming ==== | ||
- | ==== Maps ==== | + | === 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 " | 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. | ||
+ | |||
+ | Don't forget to set the title field in the .bsp file to something useful. | ||
+ | |||
+ | === 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. | ||
=== Examples of good naming schemes === | === Examples of good naming schemes === | ||
* efdatsp1.bsp - The Place of Dismay by efdat, full nickname since it is short & sp & number | * efdatsp1.bsp - The Place of Dismay by efdat, full nickname since it is short & sp & number | ||
- | * chessp1.zip - Shrine of Skank by cheshire, abbreviated nickname & sp & number | + | * chessp1.bsp - Shrine of Skank by cheshire, abbreviated nickname & sp & number |
- | * ikspq1.bsp - Before Nightfall by Iikka " | + | * ikspq1.bsp - Before Nightfall by Iikka " |
- | * ac.bsp - Adamantine Cruelty by Vondur, | + | * ac.bsp - Adamantine Cruelty by Vondur, |
* ant.bsp - Antediluvian by metlslime, abbreviated title | * ant.bsp - Antediluvian by metlslime, abbreviated title | ||
* cogs.bsp - Cogs Of Conflict by spd, a single prominent word from the title | * cogs.bsp - Cogs Of Conflict by spd, a single prominent word from the title | ||
+ | === General considerations === | ||
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). | 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. | |
- | Avoid any characters that are not a-z or 0-9. Quake engines do not handle international keyboard layouts well. Do not use uppercase characters for any files. | + | |
Before you settle, search the web for the name and make sure it is not already used. | Before you settle, search the web for the name and make sure it is not already used. | ||
+ | ==== Text file ==== | ||
+ | You should 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: [[/ | ||
+ | |||
+ | 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. | ||
+ | |||
+ | ==== Packaging ==== | ||
+ | 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. | ||
+ | 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. | ||
- | Packaging feedback: | + | 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. |
- | Please do not put stuff into pak files unless you make a mod. Standard Quake engines will only load pak files with numbers (pak0, pak1, pak2, etc) and only until there is a gap. Please use a standard zip file instead. Name it the same as the bsp file. | + | ==== Hosting ==== |
+ | Upload the final archive to https:// | ||
- | Please write a readme text file. Even if it is just "This is the Xth beta of my map ABC (xyz.bsp). -YourNick" | + | 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-ridden free hosting providers. We would not be here if people had done that in the past. Thanks! |
- | If you release beta versions, make sure to indicate that in the filenames. For example bdm1_beta2.bsp or if you want to stay more compatible: bdm1b2.bsp. | + | ==== Quaddicted' |
+ | The database of singleplayer Quake maps (and some mods) at https://www.quaddicted.com/ | ||
- | I highly recommend only using letters | + | This means that e.g. three different versions of a thing become three separate entries in the database. This allows external tools like the [[tools: |
- | As a straightforward host you can use http://www.quaketastic.com/ | + | [[/forum/viewtopic.php? |