Content Management - Revision history

Fossil: /* Add-on layout */

2011-07-18T19:35:07Z

Add-on layout

← Older revision		Revision as of 19:35, 18 July 2011
Line 92:		Line 92:
	lang-russian/russian.rmp		lang-russian/russian.rmp
	lang-russian/uqmpack.nfo		lang-russian/uqmpack.nfo
	lang-russian/shadow-content/russian-shadow.zip		lang-russian/shadow-content/russian-shadow.zip (see notes below)
	lang-russian/comm/commander.txt		lang-russian/comm/commander.txt
	lang-russian/comm/arilou.txt		lang-russian/comm/arilou.txt
Line 118:		Line 118:
	[etc.]		[etc.]
	</code>		</code>
			A shadow content zip works like the add-ons worked in the prior versions: the file structure must match the default content layout, and the files in the zip will ''shadow'' (or override) the default content.

	''russian.rmp'' contains:		''russian.rmp'' contains:
Line 139:		Line 140:
	While ''uqmpack.nfo'' file is not currently required in the add-on, we ask that you add one for the future online add-on management. This will make your add-on more user-friendly.		While ''uqmpack.nfo'' file is not currently required in the add-on, we ask that you add one for the future online add-on management. This will make your add-on more user-friendly.

	Currently, ~~addon~~ ''shadow-content'' directory '''must''' contain .zip (or .uqm) files. Only zipped files will be mounted under the root directory. This means that in order to create a single zipped ~~addon~~ file with shadow content, you have to put a zip inside a zip. In that case, it may be a good idea to zip the shadow content with method ''store'' (no compression) in order to improve the in-game performance.		====Shadow content====
			Shadow content works like the add-ons worked in the prior versions: the file structure must match the default content layout, and the files will ''shadow'' (or override) the default content.

			Currently, add-on ''shadow-content'' directory '''must''' contain .zip (or .uqm) files. Only zipped files will be mounted under the root directory. This means that in order to create a single zipped add-on file with shadow content, you have to put a zip inside a zip. In that case, it may be a good idea to zip the shadow content with method ''store'' (no compression) in order to improve the in-game performance. Please note that we intend to remove this limitation in v0.7.1. We hope to release the 0.7.1 with bugfixes as quickly as we possible, so modders may want to wait for it.

	==Current Development Status==		==Current Development Status==

Fossil: /* Add-on layout */

2011-07-17T05:37:32Z

Add-on layout

← Older revision		Revision as of 05:37, 17 July 2011
Line 86:		Line 86:
	This is better illustrated with an example:		This is better illustrated with an example:
	<code>		<code>
	addons~~/lang-russian~~/russian~~.zip~~		addons/russian-trans-2.0.zip
	~~addons/lang~~-~~russian/shadow~~-~~content/russian-shadow~~.zip
	</code>		</code>
	Where ''russian.zip'' contains:		Where ''russian-trans-2.0.zip'' contains:
	<code>		<code>
	russian.rmp		lang-russian/russian.rmp
	comm/commander.txt		lang-russian/uqmpack.nfo
	comm/arilou.txt		lang-russian/shadow-content/russian-shadow.zip
	[etc., files with layout of author's choosing]		lang-russian/comm/commander.txt
			lang-russian/comm/arilou.txt
			[etc., files with layout of author's choosing, all under lang-russian/ ]
	</code>		</code>
	and is mounted like so:		and is mounted like so:
	<code>		<code>
	/addons/lang-russian/russian.rmp		/addons/lang-russian/russian.rmp
			/addons/lang-russian/uqmpack.nfo
	/addons/lang-russian/comm/commander.txt		/addons/lang-russian/comm/commander.txt
	/addons/lang-russian/comm/arilou.txt		/addons/lang-russian/comm/arilou.txt
Line 117:		Line 119:
	</code>		</code>

	Addon ''shadow-content'' directory '''must''' contain .zip (or .uqm) files. Only zipped files will be mounted under the root directory. This means that in order to create a single zipped addon file with shadow content, you have to put a zip inside a zip. In that case, it may be a good idea to zip the shadow content with method ''store'' (no compression) in order to improve the in-game performance. A single ''russian.~~zip~~'' ~~package would then look like this~~:		''russian.rmp'' contains:
	<code>		<code>
	~~shadow~~-~~content~~/~~russian-shadow~~.~~zip~~		comm.arilou.dialogue = CONVERSATION:addons/lang-russian/comm/arilou.txt:addons/3dovoice/arilou/:addons/3dovoice/arilou/arilou.ts
	russian~~.rmp~~		comm.commander.dialogue = CONVERSATION:addons/lang-russian/comm/commander.txt:addons/3dovoice/commander/:addons/3dovoice/commander/commander.ts
	comm/commander.txt		[etc., resource identifiers of author's choosing; see content/uqm.rmp for resource strings]
	~~comm~~/~~arilou~~.~~txt~~
	[etc., ~~files with layout~~ of author's choosing]
	</code>		</code>
			An add-on must contain at least one .rmp file or it will not be loaded.
			Note that CONVERSATION resource type has three parts: the subtitles file, the voice ogg directory, and the timestamps file. If the last two are omitted, the voices will not play when this add-on is loaded. See the ''3domusic'' and ''3dovoice'' standard add-on for more examples. You may add completely new resource identifiers if you plan to add brand new content in your mod.

			''uqmpack.nfo'' contains:
			<code>
			name=Russian Pack
			author=John Doe
			version=2
			description=Russian translation of the game.
			year=2011
			min_uqm_version=0.7
			</code>
			While ''uqmpack.nfo'' file is not currently required in the add-on, we ask that you add one for the future online add-on management. This will make your add-on more user-friendly.

			Currently, addon ''shadow-content'' directory '''must''' contain .zip (or .uqm) files. Only zipped files will be mounted under the root directory. This means that in order to create a single zipped addon file with shadow content, you have to put a zip inside a zip. In that case, it may be a good idea to zip the shadow content with method ''store'' (no compression) in order to improve the in-game performance.

	==Current Development Status==		==Current Development Status==

Fossil: /* On Linux */

2011-07-17T05:07:26Z

On Linux

← Older revision		Revision as of 05:07, 17 July 2011
Line 58:		Line 58:
	/usr/local/share/uqm/content/addons/uqm-0.7.0-3domusic.uqm		/usr/local/share/uqm/content/addons/uqm-0.7.0-3domusic.uqm
	/usr/local/share/uqm/content/addons/uqm-0.7.0-voice.uqm		/usr/local/share/uqm/content/addons/uqm-0.7.0-voice.uqm
	/usr/local/share/uqm/content/addons/uqm-remix-disc1.~~zip~~		/usr/local/share/uqm/content/addons/uqm-remix-disc1.uqm
	/usr/local/share/uqm/content/addons/uqm-remix-disc2.~~zip~~		/usr/local/share/uqm/content/addons/uqm-remix-disc2.uqm
	/usr/local/share/uqm/content/addons/uqm-remix-disc3.~~zip~~		/usr/local/share/uqm/content/addons/uqm-remix-disc3.uqm
	/usr/local/share/uqm/content/version		/usr/local/share/uqm/content/version
	</code>		</code>

Fossil: /* On Linux */

2011-07-17T05:06:36Z

On Linux

← Older revision		Revision as of 05:06, 17 July 2011
Line 55:		Line 55:
	/usr/local/bin/uqm (wrapper script)		/usr/local/bin/uqm (wrapper script)
	/usr/local/lib/uqm/uqm (the actual executable)		/usr/local/lib/uqm/uqm (the actual executable)
	/usr/local/share/uqm/content/packages/uqm-0.6.0-content.uqm		/usr/local/share/uqm/content/packages/uqm-0.7.0-content.uqm
	/usr/local/share/uqm/content/~~packages~~/uqm-0.6.0-3domusic.uqm		/usr/local/share/uqm/content/addons/uqm-0.7.0-3domusic.uqm
	/usr/local/share/uqm/content/~~packages~~/uqm-0.6.0-voice.uqm		/usr/local/share/uqm/content/addons/uqm-0.7.0-voice.uqm
	/usr/local/share/uqm/content/addons~~/remix~~/uqm-remix-~~pack1~~.zip		/usr/local/share/uqm/content/addons/uqm-remix-disc1.zip
	/usr/local/share/uqm/content/addons~~/remix~~/uqm-remix-~~pack2~~.zip		/usr/local/share/uqm/content/addons/uqm-remix-disc2.zip
	/usr/local/share/uqm/content/addons~~/remix~~/uqm-remix-~~pack3~~.zip		/usr/local/share/uqm/content/addons/uqm-remix-disc3.zip
	~~/usr/local/share/uqm/content/addons/remix/remix1.rmp~~
	~~/usr/local/share/uqm/content/addons/remix/remix2.rmp~~
	~~/usr/local/share/uqm/content/addons/remix/remix3.rmp~~
	/usr/local/share/uqm/content/version		/usr/local/share/uqm/content/version
	</code>		</code>

Fossil: /* On Windows */

2011-07-17T05:06:00Z

On Windows

← Older revision		Revision as of 05:06, 17 July 2011
Line 22:		Line 22:
	<code>		<code>
	C:\Program Files\The Ur-Quan Masters\uqm.exe		C:\Program Files\The Ur-Quan Masters\uqm.exe
	C:\Program Files\The Ur-Quan Masters\content\packages\uqm-0.6.0-content.uqm		C:\Program Files\The Ur-Quan Masters\content\packages\uqm-0.7.0-content.uqm
	C:\Program Files\The Ur-Quan Masters\content\~~packages~~\uqm-0.6.0-3domusic.uqm		C:\Program Files\The Ur-Quan Masters\content\addons\uqm-0.7.0-3domusic.uqm
	C:\Program Files\The Ur-Quan Masters\content\~~packages~~\uqm-0.6.0-voice.uqm		C:\Program Files\The Ur-Quan Masters\content\addons\uqm-0.7.0-voice.uqm
	C:\Program Files\The Ur-Quan Masters\content\addons~~\remix~~\uqm-remix-~~pack1~~.~~zip~~		C:\Program Files\The Ur-Quan Masters\content\addons\uqm-remix-disc1.uqm
	C:\Program Files\The Ur-Quan Masters\content\addons~~\remix~~\uqm-remix-~~pack2~~.~~zip~~		C:\Program Files\The Ur-Quan Masters\content\addons\uqm-remix-disc2.uqm
	C:\Program Files\The Ur-Quan Masters\content\addons~~\remix~~\uqm-remix-~~pack3~~.~~zip~~		C:\Program Files\The Ur-Quan Masters\content\addons\uqm-remix-disc3.uqm
	~~C:\Program Files\The Ur-Quan Masters\content\addons\remix\remix1.rmp~~
	~~C:\Program Files\The Ur-Quan Masters\content\addons\remix\remix2.rmp~~
	~~C:\Program Files\The Ur-Quan Masters\content\addons\remix\remix3.rmp~~
	C:\Program Files\The Ur-Quan Masters\content\version		C:\Program Files\The Ur-Quan Masters\content\version
	</code>		</code>

Fossil: /* On Mac OS X */

2011-07-17T05:04:56Z

On Mac OS X

← Older revision		Revision as of 05:04, 17 July 2011
Line 46:		Line 46:
	/Applications/The Ur-Quan Masters/Contents/Resources/The Ur-Quan Masters.icns		/Applications/The Ur-Quan Masters/Contents/Resources/The Ur-Quan Masters.icns
	/Applications/The Ur-Quan Masters/Contents/Resources/content/version		/Applications/The Ur-Quan Masters/Contents/Resources/content/version
	/Applications/The Ur-Quan Masters/Contents/Resources/content/packages/uqm-0.6.0-content.uqm		/Applications/The Ur-Quan Masters/Contents/Resources/content/packages/uqm-0.7.0-content.uqm
	/Applications/The Ur-Quan Masters/Contents/Resources/content/~~packages~~/uqm-0.6.0-voice.uqm		/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/uqm-0.7.0-voice.uqm
	/Applications/The Ur-Quan Masters/Contents/Resources/content/addons~~/remix~~/uqm-remix-~~pack1~~.~~zip~~		/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/uqm-remix-disc1.uqm
	/Applications/The Ur-Quan Masters/Contents/Resources/content/addons~~/remix~~/uqm-remix-~~pack1~~.~~zip~~		/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/uqm-remix-disc2.uqm
	/Applications/The Ur-Quan Masters/Contents/Resources/content/addons~~/remix~~/uqm-remix-~~pack1~~.~~zip~~		/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/uqm-remix-disc3.uqm
	~~/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/remix/remix1.rmp~~
	~~/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/remix/remix2.rmp~~
	~~/Applications/The Ur-Quan Masters/Contents/Resources/content/addons/remix/remix3.rmp~~
	</code>		</code>

Svdb: moved Content Management in 0.7.0 to Content Management: 0.7.0 is released

2011-07-04T21:32:46Z

moved Content Management in 0.7.0 to Content Management: 0.7.0 is released

← Older revision	Revision as of 21:32, 4 July 2011
(No difference)

Fossil: /* Content directories */

2009-07-09T22:28:45Z

Content directories

← Older revision		Revision as of 22:28, 9 July 2009
Line 84:		Line 84:
	\|[[#Content base directory\|content base directory]] \|\|/ \|\|read-only		\|[[#Content base directory\|content base directory]] \|\|/ \|\|read-only
	\|-		\|-
	\|[[#Add-on shadow packages\|add-on shadow packages]], in ~~alphabetic~~ order \|\|/ \|\|read-only		\|[[#Add-on shadow packages\|add-on shadow packages]], in specified order \|\|/ \|\|read-only
	\|-		\|-
	\|[[#User data directory\|user data directory]] \|\|/ \|\|read-write		\|[[#User data directory\|user data directory]] \|\|/ \|\|read-write

Fossil at 22:26, 9 July 2009

2009-07-09T22:26:54Z

@@ Line 2: / Line 2: @@
 ==Introduction==
-The game still uses a virtual file system as before: see [[Content Management]] for information on this.  However, starting in 0.6.4, the "layering" effect of the directory system is no longer used to index files.
+The game still uses a virtual file system as before: see [[Content Management]] for information on this.  However, starting in 0.6.4, the "layering" effect of the directory system is no longer used to index files for the purposes of regular addons. The concept of addon shadow packages was introduced in 0.6.6 as a stop-gap since the resource system is not yet finished.
 ==Hey, my remixes don't work!==
@@ Line 71: / Line 71: @@
   /usr/local/share/uqm/content/addons/remix/remix3.rmp
   /usr/local/share/uqm/content/version
 </code>

Mcmartin: /* Current goals */

2009-02-16T00:49:00Z

Current goals

← Older revision		Revision as of 00:49, 16 February 2009
Line 93:		Line 93:
	* Keep user settings in a resource-map. ''Completed in Revision 1916.''		* Keep user settings in a resource-map. ''Completed in Revision 1916.''
	* Keep key configuration in a resource-map. ''Completed in Revision 2705.''		* Keep key configuration in a resource-map. ''Completed in Revision 2705.''
	* Keep Melee configuration in a resource-map.
	* Allow loads of resource files to be placed into isolated submaps to keep values separated. ''Completed in Revision 3105.''		* Allow loads of resource files to be placed into isolated submaps to keep values separated. ''Completed in Revision 3105.''
	* Allow saves to strip some or all of the common prefix to save only the "submap" component. ''Completed in Revision 3105.''		* Allow saves to strip some or all of the common prefix to save only the "submap" component. ''Completed in Revision 3105.''
	* Merge ~~all three~~ into the main resource map.		* Merge user settings and key configuration into the main resource map, eliminating the now-redundant mapres.c routines. ''Completed in Revision 3108.''
	** Right now~~, user and key data use~~ mapres.c ~~to handle all this~~. ~~Those routines should be folded into getres~~.		* Turn melee data (teams, current situation) into resource maps like the other two.
	** Old user configurations will be all of type UNKNOWNRES and be located in the ~~wrong place. This will make auto-migration possible~~.

	===Other work===		===Other work===