VFS (Civ5) - Revision history

DonQuich at 12:21, 25 September 2012

2012-09-25T12:21:49Z

← Older revision		Revision as of 12:21, 25 September 2012
Line 37:		Line 37:

	= Final warning =		= Final warning =
	{{Warning}} In some circumstances (notable the include statement in Lua, see [[Specificities of the Lua implementation in Civ5]], only the first eight characters of the file matter. Tow files starting with the same first eight characters could then be confused by the game.		{{Warning}} In some circumstances (notable the include statement in Lua, see [[Specificities of the Lua implementation in Civ5]]) only the first eight characters of the file matter. Tow files starting with the same first eight characters could then be confused by the game.


	[[Category:Civ5 Tutorials]]		[[Category:Civ5 Tutorials]]

DonQuich at 12:21, 25 September 2012

2012-09-25T12:21:21Z

← Older revision		Revision as of 12:21, 25 September 2012
Line 30:		Line 30:

	= Importing a file into the VFS =		= Importing a file into the VFS =
	* In ModBuddy, select a file in the solution ~~exlporer~~.		* In ModBuddy, select a file in the solution explorer.
	* Hit F4 (or click View > Properties Window) to open its properties.		* Hit F4 (or click View > Properties Window) to open its properties.
	* At the bottom of this new window, look for '''Import into VFS''' and set it to true.		* At the bottom of this new window, look for '''Import into VFS''' and set it to true.
	* If Civ5 is opened, you will need to exit to the main menu for this change to be applied.		* If Civ5 is opened, you will need to exit to the main menu for this change to be applied.


			= Final warning =
			{{Warning}} In some circumstances (notable the include statement in Lua, see [[Specificities of the Lua implementation in Civ5]], only the first eight characters of the file matter. Tow files starting with the same first eight characters could then be confused by the game.


	[[Category:Civ5 Tutorials]]		[[Category:Civ5 Tutorials]]

DonQuich at 12:07, 25 September 2012

2012-09-25T12:07:47Z

← Older revision		Revision as of 12:07, 25 September 2012
Line 4:		Line 4:


	== What is it? ==		= What is it? =
	[[File:ModBuddy.ImportIntoVFS.png\|frame\|The ''import into VFS'' option.]]		[[File:ModBuddy.ImportIntoVFS.png\|frame\|The ''import into VFS'' option.]]
	VFS stands for Virtual File System. Rather than locating the files directly in the file system, Civ5 looks for them in its virtual file system. This system provides the following benefits:		VFS stands for Virtual File System. Rather than locating the files directly in the file system, Civ5 looks for them in its virtual file system. This system provides the following benefits:
Line 12:		Line 12:


	== Determining whether a file must be imported or not ==		= Determining whether a file must be imported or not =
	In doubt, import your files into the VFS. But you should better stick to what is written here.		In doubt, import your files into the VFS. But you should better stick to what is written here.

Line 29:		Line 29:


	== Importing a file into the VFS ==		= Importing a file into the VFS =
	* In ModBuddy, select a file in the solution exlporer.		* In ModBuddy, select a file in the solution exlporer.
	* Hit F4 (or click View > Properties Window) to open its properties.		* Hit F4 (or click View > Properties Window) to open its properties.

DonQuich at 11:03, 24 September 2012

2012-09-24T11:03:03Z

← Older revision		Revision as of 11:03, 24 September 2012
Line 1:		Line 1:
			''This page is a part of the [[Civ5 Modding Tutorials]].''

	This article explains the Virtual File System (VFS) in Civ5. Lua developers looking for informations on the '''include''' function should look at [[Specificities of the Lua implementation in Civ5]].		This article explains the Virtual File System (VFS) in Civ5. Lua developers looking for informations on the '''include''' function should look at [[Specificities of the Lua implementation in Civ5]].

Line 32:		Line 34:
	* At the bottom of this new window, look for '''Import into VFS''' and set it to true.		* At the bottom of this new window, look for '''Import into VFS''' and set it to true.
	* If Civ5 is opened, you will need to exit to the main menu for this change to be applied.		* If Civ5 is opened, you will need to exit to the main menu for this change to be applied.


			[[Category:Civ5 Tutorials]]

DonQuich at 15:25, 22 September 2012

2012-09-22T15:25:10Z

← Older revision		Revision as of 15:25, 22 September 2012
Line 10:		Line 10:


	== Determining whether a file must imported or not ==		== Determining whether a file must be imported or not ==
	In doubt, import your files into the VFS. But you should better stick to what is written here.		In doubt, import your files into the VFS. But you should better stick to what is written here.

DonQuich at 14:48, 22 September 2012

2012-09-22T14:48:13Z

← Older revision		Revision as of 14:48, 22 September 2012
Line 4:		Line 4:
	== What is it? ==		== What is it? ==
	[[File:ModBuddy.ImportIntoVFS.png\|frame\|The ''import into VFS'' option.]]		[[File:ModBuddy.ImportIntoVFS.png\|frame\|The ''import into VFS'' option.]]
	VFS stands for Virtual File System. Rather than locating the files directly in the file system, Civ5 looks for them in its virtual file system. This ~~one fulfills two key roles~~:		VFS stands for Virtual File System. Rather than locating the files directly in the file system, Civ5 looks for them in its virtual file system. This system provides the following benefits:
	* '''Modularity:''' each mod, expansion or DLC can provide its own version of a given file without overwriting the original one. At run-time the game sequentially loads those files into the VFS, performing virtual overwrites as needed. This contrasts with the mods hell in the Elders Scrolls series for example.		* '''Modularity:''' each mod, expansion or DLC can provide its own version of a given file without overwriting the original one. At run-time the game sequentially loads those files into the VFS, performing virtual overwrites as needed. This contrasts with the mods hell in the Elders Scrolls series for example.
	* '''Packaging:''' The files in the VFS can be either independent files or parts of packages (archives). The VFS behaves as a unified resource loader.		* '''Packaging:''' The files in the VFS can be either independent files or parts of packages (archives). The VFS behaves as a unified resource loader.

DonQuich: Created page with "This article explains the Virtual File System (VFS) in Civ5. Lua developers looking for informations on the '''include''' function should look at [[Specificities of the Lua imple..."

2012-09-22T14:47:38Z

Created page with "This article explains the Virtual File System (VFS) in Civ5. Lua developers looking for informations on the '''include''' function should look at [[Specificities of the Lua imple..."

New page

This article explains the Virtual File System (VFS) in Civ5. Lua developers looking for informations on the '''include''' function should look at [[Specificities of the Lua implementation in Civ5]].

== What is it? ==
[[File:ModBuddy.ImportIntoVFS.png|frame|The ''import into VFS'' option.]]
VFS stands for Virtual File System. Rather than locating the files directly in the file system, Civ5 looks for them in its virtual file system. This one fulfills two key roles:
* '''Modularity:''' each mod, expansion or DLC can provide its own version of a given file without overwriting the original one. At run-time the game sequentially loads those files into the VFS, performing virtual overwrites as needed. This contrasts with the mods hell in the Elders Scrolls series for example.
* '''Packaging:''' The files in the VFS can be either independent files or parts of packages (archives). The VFS behaves as a unified resource loader.
* '''Sandboxing:''' whenever a mod requests a file, civ5 only looks in the VFS. This prevents mods to be allowed to look at the physical file system since this could open a security breach.

== Determining whether a file must imported or not ==
In doubt, import your files into the VFS. But you should better stick to what is written here.

'''Must be imported''' the files that are requested during the game.
* The XML UI files.
* The XML files for animations, scenes, etc.
* The Lua files (minus the exception detailed below).
* The art assets such as textures or models.

'''Should not be imported''' the files that are loaded through the project's content and actions tab (except the XML UI files, those ones should always be imported). While this is harmless most of the time, this can sometimes result in unexpected side-effects.
* The Lua files that are directly loaded through the project's content tab. This does not apply if the Lua file is associated with a XML file and you load this XML file instead. Note that if you want a Lua file to be included by other Lua or XML UI files, you will still have to import it into the VFS but you may see it loaded more times than necessary.
* The XML data and text files. Those ones are only ran at start up to modify the data tables.
* The SQL files. For the same reasons.

== Importing a file into the VFS ==
* In ModBuddy, select a file in the solution exlporer.
* Hit F4 (or click View > Properties Window) to open its properties.
* At the bottom of this new window, look for '''Import into VFS''' and set it to true.
* If Civ5 is opened, you will need to exit to the main menu for this change to be applied.