Mission Database - Revision history

Datiswous: /* References */

2024-12-06T10:47:41Z

References

← Older revision		Revision as of 10:47, 6 December 2024
Line 173:		Line 173:
	= References =		= References =
	* Thread on developer subforum: https://forums.thedarkmod.com/index.php?/topic/20624-store-missions-archive-in-svn/		* Thread on developer subforum: https://forums.thedarkmod.com/index.php?/topic/20624-store-missions-archive-in-svn/
	* Mission Database Management thread: https://forums.thedarkmod.com/index.php?/topic/11393-mission-archive-administration		* Mission Database Management thread (on developer subforum): https://forums.thedarkmod.com/index.php?/topic/11393-mission-archive-administration

Stgatilov: Some updates for unpacked missions

2024-07-17T18:41:41Z

Some updates for unpacked missions

← Older revision		Revision as of 18:41, 17 July 2024
Line 21:		Line 21:

	Here is the SVN address:		Here is the SVN address:
	:: https://svn.thedarkmod.com/project/missions_unpacked/trunk~~/fms~~/		:: https://svn.thedarkmod.com/project/missions_unpacked/trunk/

	'''But please don't rush to checkout the whole repo yet!'''		'''But please don't rush to checkout the whole repo yet!'''
Line 27:		Line 27:
	=== Checkout everything ===		=== Checkout everything ===

	Yes, you can simply copy the link above to SVN Checkout and get single working copy with all the FMs. But keep in mind that you will have to download ~10 GB of data and the working copy will take ~20 GB of space. In most cases you don't need everything in order to work with the database.		Yes, you can simply copy the link above to SVN Checkout and get single working copy with all the FMs. But keep in mind that you will have to download ~35 GB of data and the working copy will take ~70 GB of space. In most cases you don't need everything in order to work with the database.

	The typical reasons to checkout the whole repo are:		The typical reasons to checkout the whole repo are:
Line 71:		Line 71:
	Now that the directory has been created, you can checkout it: find the directory in Repo-browser, right-click it and Checkout.		Now that the directory has been created, you can checkout it: find the directory in Repo-browser, right-click it and Checkout.

	The second step is to upload pk4 ~~files~~.		The second step is to upload pk4 contents.
	<br>~~Create two sub-directories under the mission checkout directory. One named screenshots and another named~~ mission-name.pk4_dir		Create subdirectory named <tt>mission-name.pk4_dir</tt> under the mission checkout directory (replace mission-name with internal name).
	<br>( replace mission-name with ~~your preferred~~ name )		Unpack all the pk4 files of FM pack into this subdirectory of the working copy directory (i.e. checkout directory).
	~~<br>~~Unpack all the pk4 files of FM pack into ~~the mission-name.pk4_dir sub-folder~~ of the working copy directory (i.e. checkout directory).
	Open the directory in Windows Explorer, right-click the parent folder and select SVN commit.		Open the directory in Windows Explorer, right-click the parent folder and select SVN commit.
	Select all files with Shift, right-click and select Add.		Select all files with Shift, right-click and select Add.
Line 81:		Line 80:
	When everything is done, hit OK to do the actual commit.		When everything is done, hit OK to do the actual commit.

	While the pk4 ~~files~~ are already in the repository, they are not yet visible in the database.		While the pk4 contents are already in the repository, they are not yet visible in the database.
	A mission is only added when its directory contains <tt>fminfo.xml</tt> file, so now you need to add it.		A mission is only added when its directory contains <tt>fminfo.xml</tt> file, so now you need to add it.
	You can take this file from another FM (find it in Repo-browser, right-click, Open with, select text editor), and adjust it for the FM being added.		You can take this file from another FM (find it in Repo-browser, right-click, Open with, select text editor), and adjust it for the FM being added.
Line 113:		Line 112:

	When you have created <tt>fminfo.xml</tt> file, double-check that all properties are correct.		When you have created <tt>fminfo.xml</tt> file, double-check that all properties are correct.
	Then use SVN to add and commit the file, just like you did with pk4 ~~file~~.		Then use SVN to add and commit the file, just like you did with pk4 contents.

	If you did something wrong (most likely), then you will see an error saying that "Commit blocked by pre-commit hook".		If you did something wrong (most likely), then you will see an error saying that "Commit blocked by pre-commit hook".
Line 122:		Line 121:
	As the last step, create subdirectory named <tt>screenshots</tt> in the working copy directory.		As the last step, create subdirectory named <tt>screenshots</tt> in the working copy directory.
	Put screenshots in .jpg or .png format into the directory: they will be displayed in in-game mission downloader.		Put screenshots in .jpg or .png format into the directory: they will be displayed in in-game mission downloader.
	Then add and commit all the screenshot files into the repository~~, same way as you did for pk4 and xml files~~.		Then add and commit all the screenshot files into the repository.

	= Update Mission =		= Update Mission =

Nbohr1more: /* Add New Mission */

2024-07-16T22:56:22Z

Add New Mission

@@ Line 99: / Line 99: @@
 * Ampersand (<tt>&amp;amp;</tt>) quotes (<tt>&amp;quot;</tt> or <tt>&amp;apos;</tt>) and angle brackets (<tt>&amp;lt;</tt> or <tt>&amp;gt;</tt>): [https://stackoverflow.com/questions/1091945/what-characters-do-i-need-to-escape-in-xml-documents reference]
 * Line break symbol can be inserted as <tt>&amp;#10;</tt> according to [https://stackoverflow.com/questions/2004386/how-to-save-newlines-in-xml-attribute reference]
 When you have created <tt>fminfo.xml</tt> file, double-check that all properties are correct.

Nbohr1more: /* References */

2024-07-16T22:51:32Z

References

← Older revision		Revision as of 22:51, 16 July 2024
Line 162:		Line 162:
	= References =		= References =
	* Thread on developer subforum: https://forums.thedarkmod.com/index.php?/topic/20624-store-missions-archive-in-svn/		* Thread on developer subforum: https://forums.thedarkmod.com/index.php?/topic/20624-store-missions-archive-in-svn/
			* Mission Database Management thread: https://forums.thedarkmod.com/index.php?/topic/11393-mission-archive-administration

Nbohr1more at 22:50, 16 July 2024

2024-07-16T22:50:41Z

Show changes

Nbohr1more: /* Update Mission */

2024-07-16T22:42:39Z

Update Mission

← Older revision		Revision as of 22:42, 16 July 2024
Line 127:		Line 127:
	<br>Make sure no files or folders have spaces or special characters in their names		<br>Make sure no files or folders have spaces or special characters in their names
	<br>Navigate to the parent directory of the querty folder and right-click querty then choose commit		<br>Navigate to the parent directory of the querty folder and right-click querty then choose commit
	<br>If the mission author removed files or you are unsure, you will need to compare the existing copy to the new version prior to merging		<br><br>If the mission author removed files or you are unsure, you will need to compare the existing copy to the new version prior to merging
	<br>For Windows users the program WinMerge is a good tool, Linux users can use "diff -r folderA, folderB"		<br>For Windows users the program WinMerge is a good tool, Linux users can use "diff -r folderA, folderB"
	<br>Identify additions and removals then overwrite the contents of the query.pk4_dir then perform SVN Add and SVN Delete actions to all relevant items		<br>Identify additions and removals then overwrite the contents of the query.pk4_dir then perform SVN Add and SVN Delete actions to all relevant items

Nbohr1more: /* Update Mission */

2024-07-16T22:42:07Z

Update Mission

← Older revision		Revision as of 22:42, 16 July 2024
Line 117:		Line 117:

	First of all, make sure you have up-to-date working copy of the FM directory.		First of all, make sure you have up-to-date working copy of the FM directory.
	If you already have working copy, do right-click and SVN Update in it in Windows Explorer.		<br>If you already have working copy, do right-click and SVN Update in it in Windows Explorer.
	If you don't have it yet, then open Repo-browser, find the directory named by FM's internal name, right-click and select Checkout.		<br>If you don't have it yet, then open Repo-browser, find the directory named by FM's internal name, right-click and select Checkout.
	If you don't know the internal name, you can learn it like this: install the FM in the game, then look what is written in the <tt>currentfm.txt</tt> file.		<br>If you don't know the internal name, you can learn it like this: install the FM in the game,
	Suppose internal name is "qwerty".		<br>then look what is written in the <tt>currentfm.txt</tt> file.
			<br><br>Suppose internal name is "qwerty".
	~~There are two ways to update~~ the ~~FM:~~		<br><br>If you know the author didn't remove any files from the new version, just extract the contents of the new PK4 to the query.pk4_dir and overwrite the contents.
	# Minor update changes one or several lines in some file, e.g. in .map file or in .gui file. Such update is usually done when TDM engine is changed, FM gets broken, and merely a small spawnarg change is enough to return proper behavior. Usually such changes are done by TDM developers with approval of FM authors.		<br>Then browse the sub-folders for any un-versioned new items ( usually will have a question mark indicator ) and right-click them and select SVN Add
	~~# Major update covers everything else. It happens when FM~~ author ~~sends a~~ new version ~~of pk4 file~~, ~~with arbitrary changes in .map file, and probably some other changes.~~		<br>Then update the version number in the FM XML file as well as the file size
			<br>Make sure no files or folders have spaces or special characters in their names
	~~When doing minor update, prefer editing existing pk4 archive instead~~ of ~~creating a~~ new ~~one from scratch.~~		<br>Navigate to the parent directory of the querty folder and right-click querty then choose commit
	~~For instance, you can open the archive in 7-zip, extract only one file which you want to modify, change it in text editor, then add it back~~ to the ~~archive in 7-zip (overwriting the old version)~~.		<br>If the mission author removed files or you are unsure, you will need to compare the existing copy to the new version prior to merging
	~~It is a '''bad''' idea to extract everything, do some changes, then create a brand new pk4 archive.~~		<br>For Windows users the program WinMerge is a good tool, Linux users can use "diff -r folderA, folderB"
			<br>Identify additions and removals then overwrite the contents of the query.pk4_dir then perform SVN Add and SVN Delete actions to all relevant items
	~~Regardless of how major~~ the ~~update is, keep in mind SVN storage specifics to avoid rapid growth of server storage requirements~~.		<br>Then update the FM XML and commit as described above
	~~Unless full size of FM package is smaller than 100 MB, please run the diff optimization tool. The tool is located in <tt>devel\pk4diff\bin~~<~~/tt~~> in the ~~assets SVN repo and requires Python 3. The tool will check how much data is really changed inside the archive. If the changes account~~ for ~~less than 10% of the full package size, then the tool~~ will ~~repack it to ensure that this update takes only~~ a ~~very little additional space on server. See more details in [[#Storage Concerns]] section.~~

	~~The procedure (for Windows~~) ~~is as follows:~~

	~~# replace~~ the ~~.pk4~~ in ~~your working copy of~~ the ~~mission database with your modified .pk4~~
	~~# if you haven't done so already, install Python 3 and make sure during~~ the ~~installation that it's added as an environment variable~~
	~~# copy&paste pk4diff.py, pk4diffexe.exe and xdelta3.exe from~~ <tt>~~darkmod_svn\devel\pk4diff\bin~~<~~/tt~~> to the ~~FM's mission database folder next to the .pk4~~
	~~# open the Windows command console~~
	~~# type cd into the console, then copy-paste in the path~~ of the ~~FM's SVN~~ folder and hit enter to switch to this folder. Use "cd /d" instead of "cd" if this is a different drive than the one currently mentioned in the console. For exampple: cd D:\games\darkmod_fms\packed\fms\cleanneighbourhood
	~~# paste this command into the command console, adjusting the name of the .pk4: py pk4diff.py~~ -~~-optimize cleanneighbourhood.pk4~~
	~~# load the .pk4 in TDM to test that it works,~~ then commit it

	~~Now you need to edit~~ <tt>~~fminfo.xml</tt> file:~~
	~~# Increment the integer in "version" property by one. Otherwise in-game downloader won't know that~~ the mission ~~has been updated.~~
	~~# Probably update "size" property if it has changed significantly.~~

	~~After~~ you ~~have dealt both with pk4 storage concerns and with XML file update~~, ~~it's time~~ to ~~commit~~ the ~~changes.~~
	~~Open working copy directory in~~ Windows ~~Explorer~~, ~~right~~-~~click and select SVN Commit.~~
	~~You should see at least two files marked as modified with checkboxes set: <tt>qwerty.pk4~~<~~/tt~~> and ~~<tt>fminfo.xml</tt>.~~
	~~Write commit message which describes~~ the ~~changes. Start commit message with FM internal name in brackets.~~
	~~If the new version came from~~ the ~~author, write something like "New version: sent to me by XyMegaMapper yesterday"~~.
	~~If the update did not come from FM author,~~ then all ~~the changes must be described in full detail!~~
	~~In case of minor~~ update~~, it can be something like "In guis/mainmenu_custom_defs.gui, removed MM_BRIEFING_VIDEO_MATERIAL_K defines for K > 1".~~
	~~Finally, click OK to~~ commit ~~the changes.~~

	= Storage Concerns =		= Storage Concerns =

Nbohr1more: /* Add New Mission */

2024-07-16T22:12:39Z

Add New Mission

← Older revision		Revision as of 22:12, 16 July 2024
Line 72:		Line 72:

	The second step is to upload pk4 files.		The second step is to upload pk4 files.
	<br>~~Two~~ sub-directories under the mission checkout directory. One named screenshots and another named mission-name.pk4_dir ( replace mission-name with your preferred name )		<br>Create two sub-directories under the mission checkout directory. One named screenshots and another named mission-name.pk4_dir
	<br>Unpack all the pk4 files of FM into the mission-name.pk4_dir folder in the working copy directory (i.e. checkout directory).		<br>( replace mission-name with your preferred name )
	~~<br>Copy screenshots to the corresponding sub-folder~~		<br>Unpack all the pk4 files of FM pack into the mission-name.pk4_dir sub-folder of the working copy directory (i.e. checkout directory).
	Open the directory in Windows Explorer, right-click and select SVN commit.		Open the directory in Windows Explorer, right-click the parent folder and select SVN commit.
	Select all files with Shift, right-click and select Add.		Select all files with Shift, right-click and select Add.
	Also set checkboxes for these files.		Also set checkboxes for these files.

Nbohr1more: /* Add New Mission */

2024-07-16T20:31:23Z

Add New Mission

← Older revision		Revision as of 20:31, 16 July 2024
Line 72:		Line 72:

	The second step is to upload pk4 files.		The second step is to upload pk4 files.
	~~Copy~~ all the pk4 files of FM into the working copy directory (i.e. checkout directory).		<br>Two sub-directories under the mission checkout directory. One named screenshots and another named mission-name.pk4_dir ( replace mission-name with your preferred name )
			<br>Unpack all the pk4 files of FM into the mission-name.pk4_dir folder in the working copy directory (i.e. checkout directory).
			<br>Copy screenshots to the corresponding sub-folder
	Open the directory in Windows Explorer, right-click and select SVN commit.		Open the directory in Windows Explorer, right-click and select SVN commit.
	Select all ~~pk4~~ files with Shift, right-click and select Add.		Select all files with Shift, right-click and select Add.
	Also set checkboxes for these files.		Also set checkboxes for these files.
	Write commit message in the text area above: it should start with internal name of FM in brackets.		Write commit message in the text area above: it should start with internal name of FM in brackets.
Line 109:		Line 111:
	Put screenshots in .jpg or .png format into the directory: they will be displayed in in-game mission downloader.		Put screenshots in .jpg or .png format into the directory: they will be displayed in in-game mission downloader.
	Then add and commit all the screenshot files into the repository, same way as you did for pk4 and xml files.		Then add and commit all the screenshot files into the repository, same way as you did for pk4 and xml files.


	= Update Mission =		= Update Mission =

Nbohr1more: /* SVN */

2024-07-16T20:18:14Z

SVN

← Older revision		Revision as of 20:18, 16 July 2024
Line 21:		Line 21:

	Here is the SVN address:		Here is the SVN address:
	:: https://svn.thedarkmod.com/project/~~missions~~/trunk		:: https://svn.thedarkmod.com/project/missions_unpacked/trunk/fms/

	'''But please don't rush to checkout the whole repo yet!'''		'''But please don't rush to checkout the whole repo yet!'''
Line 48:		Line 48:
	You can checkout only this directory in order to work with FM, just put this checkout address:		You can checkout only this directory in order to work with FM, just put this checkout address:

	:: https://svn.thedarkmod.com/project/~~missions~~/trunk/fms/qwerty		:: https://svn.thedarkmod.com/project/missions_unpacked/trunk/fms/qwerty

	Or find the FM directory in Repo-browser, right-click and select Checkout.		Or find the FM directory in Repo-browser, right-click and select Checkout.

	Detailed instructions in the rest of the article assume this approach.		Detailed instructions in the rest of the article assume this approach.


	= Add New Mission =		= Add New Mission =