Unvanquished - User contributions [en-gb]

Filesystem

2014-07-01T11:16:51Z

Amanieu: /* DEPS file */

Unvanquished stores its resources (maps, sounds, textures, models etc) in ''packages''. To be able to use your own resources or modify the existing one, you will need a basic understanding of how this system works.

= Overview =
The game looks in two locations (by default) for packages:
{{Game Locations}}

During startup the game extracts the latest versions of all packages it recognises (how does it know?) into a virtual filesystem. Every package is extracted to the same spot (confirm?) so duplicate files with overwrite each other (in what order?).

To use your own resources you need to put them into your own package and tell the game to use them.

= Packaging Details =
== Types ==
* '''pk3dir''' folders are easier for your to work with, because they are just a folder
* '''pk3''' compressed files are better to send over the web once you want to release your work

Conversion process: extract or compress and then rename to suit.

== Naming and Versioning ==
The name of any package is split into three parts, each separated with an underscore:
* basename (eg "map-nano")
* version (eg 2004-04-01)
* file extension (.pk3 or .pk3dir)

Example: ''map-nano_2004-04-01.pk3''

=== Rules ===
* Underscores are for separating the three parts, nothing else
* Map packages must have 'map-' at the beginning of their basename for the engine to filter them properly.

=== Other notes ===
* A fourth section ([https://en.wikipedia.org/wiki/Checksum checksum]) is sometimes used when downloading maps, but should never be added manually.

== Filesystem layout ==
Use only the folders you need. If there is a chance your filenames could clash with files from other packages, put them in a folder with the name of your project/package. Examples are below.

{| class="wikitable"
|-
! Folder
! Description and notes
! Example
|-
| /about
| Info and licensing about your package.
| /about/map-parpax.txt
|-
| /textures
| .crn texture files
| /textures/parpax_evillair/
|-
| /sound
| Sound files.
| /sound/parpax
|-
| /scripts
| .shader, .arena, .particle
| /scripts/parpax.arena
|-
| /minimaps
|
|
/minimaps/parpax_upper.png
/minimaps/parpax_lower.png
/minimaps/parpax.minimap
|-
| /map
| .map .bsp .navMesh (for bots)
| /map/parpax.bsp
|-
| /levelshots
| "Loading screen" picture of a map level
| /levelshots/parpax.jpg
|-
| /gfx
| ???
| /gfx/parpax/
|-
| /DEPS (file)
| Depedencies file. See next section.
| /DEPS
|-
|}

== DEPS file ==
Packages like maps sometimes depend on other packages for resources, eg textures. DEPS files are put in packages to tell the game when dependencies are required.

* Plain-text file. Use an editor like notepad if you are not familiar with plain-text files.
* Must be located in the 'root' of the package, not in a sub-folder

Example DEPS file from map-parpax_d03a.pk3:
tex-common
tex-ex
tex-exm
tex-pk01
tex-pk02
tex-space
tex-trak5

= Howto: create your own package =
Find your user's package directory
[[File:Dir homepkg.png]]

Create a pk3dir folder
[[File:Dir_homepkg_newfolder.png]]

Place inside the files you want to use. Make sure you follow the filesystem organisation guidelinees, or Fuma will eat you.
[[File:Dir inpackage.png]]

Start unvanquished with the fs_extrapaks variable set to include your package. See [[Running_the_game#Advanced_options]] for more details.

$ unvanquished +set fs_extrapaks tutorialexample

Now test the game with your resources loaded

= Naming conventions =
Please follow these conventions when sharing your packages.

==Sharing Temporary pk3 files==

When sharing pk3 files that are not supposed to be standalone files of the game installation, please use one of the following two formats, so that it will be easier for others to find out the latest version:

name_year-month-day-time.pk3
name_year-month-day-time-author.pk3

The date and time is the time when you package the pk3 and uses the following format:

year: <2000-2100>
month: <01-12>
day: <01-31>
time: <00-24><00-59> (hour and minute, in GMT/UTC)
author: Nickname as lowercase alphanumeric

For example:

drill_2014-05-29-1527.pk3
drill_2014-05-29-1527-viech.pk3

In case you're having issues with UTC: If your time zone's offset is positive, substract it, otherwise add it (e.g. 20:00 UTC+2 = 18:00 UTC; 20:00 UTC-6 = 02:00 UTC of the next day). Keep local daylight saving in mind. If you're using the 12 hour time format read here.

The reason for using this time format is that it can be sorted by using lexicographical order and is still human readable (as opposed to the unix timestamp, which also isn't easily available for windows users).

==Sharing preview versions of standalone pk3 files==

For pk3 files that are to be included with the release, for example maps and texture packages, there are two scenarios. If you are the main author of the package in question and it is unlikely that others will want to release a version of their own, you can use the following format:

name_targetversion~counter.pk3

For example:

map-spacetracks_1.0~1.pk3

The "~" tells the engine that the pk3 is to be ordered before the specified target version. For example, "tex-common_1.0~1.pk3" will be considered older than "tex-common_1.0~2.pk3" which in turn will be considered older than "tex-common_1.0.pk3", so the target release will always overwrite any preview version.

If you are not the only regular author of the pk3 in question, please use the date & time format above instead of the counter:

name_targetversion~year-month-day-time.pk3
name_targetversion~year-month-day-time-author.pk3

For example:

unvanqushed_0.28.0~2014-05-29-1637.pk3
unvanqushed_0.28.0~2014-05-29-1637-viech.pk3

==Releasing fixes to standalone pk3 files==

If you are not the main author of a pk3 but want to release a version with additions or bugfixes, use "+" instead of "~" to order your version after the regular release:

name_currentversion+counter.pk3

For example:

map-spacetracks_1.0+1.pk3

Here "1.0" was the author's original release and "+1" was added to mark an update without interfering with the author's versioning scheme.

Template:Game locations

2014-07-01T11:11:05Z

Amanieu:

{| class="wikitable"
|-
! Platform
! Variant
! Default Binary Directory (fs_libpath)
! Default Data Directory (fs_basepath)
! Default User Directory (fs_homepath)
! Notes
|-
! rowspan="2" | Windows
| 32 bit
| colspan="2" | C:\Program Files\Unvanquished
| rowspan="2" | My Documents\My Games\Unvanquished
| rowspan="2" | The actual directories depends on where the game was installed.
|-
| 64 bit
| colspan="2" | C:\Program Files (x86)\Unvanquished
|-
! Mac
|
| Unvanquished/Unvanquished.app/Contents/MacOS
| Unvanquished/
| ~/Library/Application Support/Unvanquished
| The data directory is the directory containing Unvanquished.app.
|-
! rowspan=3 | Linux
| Compiled from source
| colspan="2" | Path containing binaries
| rowspan=3 | ~/.unvanquished
| rowspan=3 | The default user directory is a [https://en.wikipedia.org/wiki/Dotfile hidden dotfile].
|-
| Installed from repo
| /usr/lib/unvanquished
| /usr/share/unvanquished
|-
|}
<noinclude>
This template lists the locations of:
* Default game install directories
* Default user storage directories used by the game
</noinclude>

User:Amanieu/Getting Started With PNaCl

2013-11-30T07:40:10Z

Amanieu:

Steps to compile and run the NaCl game code:

# Download the NaCl SDK from Google: https://developers.google.com/native-client/sdk/download
# In CMake, disable the QVM_COMPAT option and point the NACL_SDK_PATH variable to the version of the SDK you want to use (pepper_30 for example)
# If you get an error about PYTHONPATH, it means that your system python is python 3. Set PNACLPYTHON to /bin/python2 to resolve this issue.
# Build the NaCl game code (BUILD_GAME_NACL)
# From the tools/ subdirectory of the NaCl SDK, copy the following files to the directory containing the engine executable (example is linux x86_64, adjust for your platform):
* Copy sel_ldr_x86_64 to sel_ldr
* (Linux only) Copy nacl_helper_bootstrap_x86_64 to nacl_helper_bootstrap
* Copy irt_core_x86_64.nexe to irt_core-x86_64.nexe (Note the dash vs underscore when renaming)
# When running the game, vm_game = 0 will use the NaCl module main/game-<arch>.nexe, vm_game = 1 will use the native module main/game
# Keep in mind that modules are only loaded from fs_libpath (which should be the directory containing the executable).

User:Amanieu/Getting Started With PNaCl

2013-11-29T09:57:59Z

Amanieu:

User:Amanieu/Getting Started With PNaCl

2013-11-29T09:49:57Z

Amanieu: Created page with "Steps to compile and run the NaCl game code: # Download the NaCl SDK from Google: https://developers.google.com/native-client/sdk/download # In CMake, disable the QVM_COMPAT ..."