TANE Developer Release Build - Revision history

Tonyhilliam at 01:52, 21 February 2017

2017-02-21T01:52:58Z

← Older revision		Revision as of 01:52, 21 February 2017
Line 1:		Line 1:
			THIS PAGE IS OBSOLETE. IT IS CURRENTLY LEFT HERE FOR RESURRECTION AND UPDATING AT A LATER DATE IF REQUIRED.

	This page describes the [[Trainz A New Era\|TANE]] Developer Release build, which is available to members of the Trainz Pioneer Council and the Trainz Enthusiast Group. Information provided on this page is publicly visible and not covered by any NDA, however it should be noted that the features described here are NOT available to the public, and may never be available to the public in their current form. The features described here do not relate to any [[Trainz Release Versions\|retail version of Trainz]] and should not be assumed to relate to any future retail version of Trainz. This page may include descriptions of in-development features which are not currently available in the Developer Release build.		This page describes the [[Trainz A New Era\|TANE]] Developer Release build, which is available to members of the Trainz Pioneer Council and the Trainz Enthusiast Group. Information provided on this page is publicly visible and not covered by any NDA, however it should be noted that the features described here are NOT available to the public, and may never be available to the public in their current form. The features described here do not relate to any [[Trainz Release Versions\|retail version of Trainz]] and should not be assumed to relate to any future retail version of Trainz. This page may include descriptions of in-development features which are not currently available in the Developer Release build.

Line 51:		Line 53:
	Using an older version of TANE after having used a newer version of TANE may corrupt your installed data. This may require a database rebuild or complete clean to resolve. (Power users can avoid this problem by using different data paths for each build.)		Using an older version of TANE after having used a newer version of TANE may corrupt your installed data. This may require a database rebuild or complete clean to resolve. (Power users can avoid this problem by using different data paths for each build.)

			THIS PAGE IS OBSOLETE. IT IS CURRENTLY LEFT HERE FOR RESURRECTION AND UPDATING AT A LATER DATE IF REQUIRED.

	= Major Program Features=		= Major Program Features=
Line 184:		Line 187:
	=Discussion and Sharing=		=Discussion and Sharing=
	The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.		The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.

			THIS PAGE IS OBSOLETE. IT IS CURRENTLY LEFT HERE FOR RESURRECTION AND UPDATING AT A LATER DATE IF REQUIRED.

	=See Also=		=See Also=
	[[Trainz:_A_New_Era]]		[[Trainz:_A_New_Era]]

Tonyhilliam at 04:20, 5 May 2015

2015-05-05T04:20:34Z

← Older revision		Revision as of 04:20, 5 May 2015
Line 184:		Line 184:
	=Discussion and Sharing=		=Discussion and Sharing=
	The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.		The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.

			=See Also=
			[[Trainz:_A_New_Era]]

Windwalkr at 07:42, 26 June 2014

2014-06-26T07:42:05Z

← Older revision		Revision as of 07:42, 26 June 2014
Line 84:		Line 84:
	** Known Issue: The site is a placeholder.		** Known Issue: The site is a placeholder.
	* 'File > Start Trainz' - Opens a new Game window.		* 'File > Start Trainz' - Opens a new Game window.
	* 'File > Open Test Track' - Opens "Test Track", the new physics testing module.		* 'File > Open Test Track' - Opens [[Test Track]], the new physics testing module.
	* 'File > Import Content' - Allows importing of content from the local disk.		* 'File > Import Content' - Allows importing of content from the local disk.
	** Known issue: Only entire folders of content can be selected for imported at the current time. The content within the folder may be in source form, or CDP.		** Known issue: Only entire folders of content can be selected for imported at the current time. The content within the folder may be in source form, or CDP.
Line 173:		Line 173:

	==Test Track==		==Test Track==
			[[Test Track]] is a testing environment for train physics. This is intended to both allow content creators to tune their vehicle engine parameters, and for [[N3V Games]] to tune and test the game physics systems under different scenarios.

	TBD.		TBD.

Windwalkr: /* Launch Window */

2014-06-26T07:38:59Z

Launch Window

← Older revision		Revision as of 07:38, 26 June 2014
Line 70:		Line 70:

	The Trainz build number is displayed at the bottom right of the launch window.		The Trainz build number is displayed at the bottom right of the launch window.
	** Known issue: The build number is not rendered correctly on any platform.		:* Known issue: The build number is not rendered correctly on any platform.
	** Known issue: The displayed build number is currently a placeholder and should not be used.		:* Known issue: The displayed build number is currently a placeholder and should not be used.

	==Main Menu==		==Main Menu==

Windwalkr: /* Log Window */

2014-06-26T07:38:34Z

Log Window

← Older revision		Revision as of 07:38, 26 June 2014
Line 167:		Line 167:
	==Log Window==		==Log Window==
	A global log viewer may be accessed via the "Developer > Show Logs" menu. This displays game logs equivalent to TS12's "Content Manager Log Panel". As per TS12, this logs all content operations that have occurred recently, allowing you to review the recent actions that you have taken and the success or failure of each action. The logs also include messages from the game runtime, including script messages, script exception logs, and resource load failures.		A global log viewer may be accessed via the "Developer > Show Logs" menu. This displays game logs equivalent to TS12's "Content Manager Log Panel". As per TS12, this logs all content operations that have occurred recently, allowing you to review the recent actions that you have taken and the success or failure of each action. The logs also include messages from the game runtime, including script messages, script exception logs, and resource load failures.
	** Known Issue: There is currently no mechanism for filtering or searching the logs.
	** Known Issue: There is currently no way to expand or contract parent entries to show/hide the children.
	** Known Issue: The icon on parent entries does not necessarily indicate the status of child entries.

			:* Known Issue: There is currently no mechanism for filtering or searching the logs.
			:* Known Issue: There is currently no way to expand or contract parent entries to show/hide the children.
			:* Known Issue: The icon on parent entries does not necessarily indicate the status of child entries.

	==Test Track==		==Test Track==

Windwalkr at 07:37, 26 June 2014

2014-06-26T07:37:08Z

← Older revision		Revision as of 07:37, 26 June 2014
Line 34:		Line 34:

	==Installing Additional Content==		==Installing Additional Content==
	The Developer Preview build supports importing of content folders using the "File > Import Content" menu or by dragging content folders from Windows Explorer/Finder onto any in-game "Trainz Content" window (opened by clicking 'Manage Content' from the Launcher window.) The imported content folder(s) may include raw content files or CDP files. Note that you need to import the folder that contains the items (i.e. not a .cdp file directly). Users should keep in mind that many content types are not supported or are incompletely supported - these should import correctly but may not function within the game environment. The Developer Preview build does not support asset validation at the current time; faulty content may simply fail to load correctly, or may crash the build.		The Developer Preview build supports importing of content folders using the "File > Import Content" menu or by dragging content folders from Windows Explorer/Finder onto any in-game "Trainz Content" window (opened by clicking 'Manage Content' from the Launcher window.) The imported content folder(s) may include raw content files or CDP files. Note that when using the "Import Content" menu, you need to import the folder that contains the items (i.e. not a .cdp file directly). Users should keep in mind that many content types are not supported or are incompletely supported - these should import correctly but may not function within the game environment. The Developer Preview build does not support asset validation at the current time; faulty content may simply fail to load correctly, or may crash the build.

	==Cleaning the Build==		==Cleaning the Build==
Line 80:		Line 80:
	* 'File > New Launch Window' - Reopens the launch window.		* 'File > New Launch Window' - Reopens the launch window.
	* 'File > New Content Window' - Opens a new Content window.		* 'File > New Content Window' - Opens a new Content window.
			* 'File > Close Window' - Closes the active window.
			* 'File > View Online Documentation' - Opens the documentation web site.
			** Known Issue: The site is a placeholder.
	* 'File > Start Trainz' - Opens a new Game window.		* 'File > Start Trainz' - Opens a new Game window.
			* 'File > Open Test Track' - Opens "Test Track", the new physics testing module.
	* 'File > Import Content' - Allows importing of content from the local disk.		* 'File > Import Content' - Allows importing of content from the local disk.
	** Known issue: Only entire folders of content can be selected for imported at the current time. The content within the folder may be in source form, or CDP.		** Known issue: Only entire folders of content can be selected for imported at the current time. The content within the folder may be in source form, or CDP.
Line 88:		Line 92:
	* 'Developer > Rebuild Content' - Rebuilds the Trainz Asset Database by scanning all installed content. Slow and rarely beneficial. Recommended as a last resort only.		* 'Developer > Rebuild Content' - Rebuilds the Trainz Asset Database by scanning all installed content. Slow and rarely beneficial. Recommended as a last resort only.
	* 'Developer > Show Logs' - Displays a log viewer window. Additional details can be found below.		* 'Developer > Show Logs' - Displays a log viewer window. Additional details can be found below.
			* 'Developer > Clear Logs' - Permanently clears any existing log entries.
			* 'Developer > Show Script Debugger' - Shows a script debug window. This is powerful, but exceedingly primitive and as such is only useful to power-users.

	==Command-Line==		==Command-Line==
Line 165:		Line 171:
	** Known Issue: The icon on parent entries does not necessarily indicate the status of child entries.		** Known Issue: The icon on parent entries does not necessarily indicate the status of child entries.

	=~~Physics Testing Module (Stand Alone version)~~=
	~~In addition to the developer builds of TANE being released during the Alpha phase, we will be releasing a stand alone version of the [[driving physics tools]]~~. ~~This module will be integrated into TANE later on once the user interface is up and running. You can read more about the tools by clicking on the link above~~.		==Test Track==
			TBD.


			==Script Debugger==
			TBD.


	=Discussion and Sharing=		=Discussion and Sharing=
	The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.		The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.

Windwalkr at 05:24, 17 June 2014

2014-06-17T05:24:19Z

← Older revision		Revision as of 05:24, 17 June 2014
Line 34:		Line 34:

	==Installing Additional Content==		==Installing Additional Content==
	The Developer Preview build supports importing of content folders using the "File > Import Content" menu. The imported content folder(s) may include raw content files or CDP files. Note that you need to import the folder that contains the items (i.e. not a .cdp file directly). Users should keep in mind that many content types are not supported or are incompletely supported - these should import correctly but may not function within the game environment. The Developer Preview build does not support asset validation at the current time; faulty content may simply fail to load correctly, or may crash the build.		The Developer Preview build supports importing of content folders using the "File > Import Content" menu or by dragging content folders from Windows Explorer/Finder onto any in-game "Trainz Content" window (opened by clicking 'Manage Content' from the Launcher window.) The imported content folder(s) may include raw content files or CDP files. Note that you need to import the folder that contains the items (i.e. not a .cdp file directly). Users should keep in mind that many content types are not supported or are incompletely supported - these should import correctly but may not function within the game environment. The Developer Preview build does not support asset validation at the current time; faulty content may simply fail to load correctly, or may crash the build.

	==Cleaning the Build==		==Cleaning the Build==
Line 112:		Line 112:
	** Known issue: when changing from a large list of content to a smaller one, the list scroll position is not reset. If you are below the bottom of the new list, you will need to scroll up to view any content.		** Known issue: when changing from a large list of content to a smaller one, the list scroll position is not reset. If you are below the bottom of the new list, you will need to scroll up to view any content.
	** Known issue: scroll bars do not auto-hide when appropriate.		** Known issue: scroll bars do not auto-hide when appropriate.
	** Known issue: progress indication is not visible on Windows builds.
	* Right clicking on any content in the list displays a popup contextual menu which allows various content management commands (see below.) Holding down appropriate modifiers while selecting content allows for multiple selection.		* Right clicking on any content in the list displays a popup contextual menu which allows various content management commands (see below.) Holding down appropriate modifiers while selecting content allows for multiple selection.
	** Known issue: The Mac OS X user interface guidelines call for any essential contextual menu command to have an alternative in the main menu bar. This does not currently exist.		** Known issue: The Mac OS X user interface guidelines call for any essential contextual menu command to have an alternative in the main menu bar. This does not currently exist.

Windwalkr at 00:27, 11 June 2014

2014-06-11T00:27:00Z

← Older revision		Revision as of 00:27, 11 June 2014
Line 48:		Line 48:

	It is also not possible to run multiple simultaneous instances of the same installation at the current time. The first-started process will lock the user data files, and subsequent startup attempts will "hang" waiting for access. If you accidentally start a duplicate copy of TANE.exe (Windows only), you may need to use Task Manager to terminate it.		It is also not possible to run multiple simultaneous instances of the same installation at the current time. The first-started process will lock the user data files, and subsequent startup attempts will "hang" waiting for access. If you accidentally start a duplicate copy of TANE.exe (Windows only), you may need to use Task Manager to terminate it.

			Using an older version of TANE after having used a newer version of TANE may corrupt your installed data. This may require a database rebuild or complete clean to resolve. (Power users can avoid this problem by using different data paths for each build.)


Line 60:		Line 62:
	* 'Start Trainz' - Attempts to open a game window using a hard-coded session Asset ID, which may vary from build to build. Other routes, sessions, etc. can be loaded using through the Manage Content 'View Asset In Game" command.		* 'Start Trainz' - Attempts to open a game window using a hard-coded session Asset ID, which may vary from build to build. Other routes, sessions, etc. can be loaded using through the Manage Content 'View Asset In Game" command.
	** Known issue: The Settings window will accept your Planet Auran details but will not currently show a verification confirmation until you press 'Start Trainz'.		** Known issue: The Settings window will accept your Planet Auran details but will not currently show a verification confirmation until you press 'Start Trainz'.
	** Known issue: Certain systems must complete loading before ~~most other~~ windows can be opened. If loading is still in progress, attempts to open ~~additional~~ windows will respond slowly. A user-visible progress indicator should be shown here but is not yet implemented.		** Known issue: Certain systems must complete loading before any 3D windows can be opened. If loading is still in progress, attempts to open 3D windows will respond slowly. A user-visible progress indicator should be shown here but is not yet implemented.
	* 'Manage Content…' - Opens a Content window defaulted to displaying all installed content.		* 'Manage Content…' - Opens a Content window defaulted to displaying all installed content.
	* 'Settings…' - Opens the game settings window.		* 'Settings…' - Opens the game settings window.
Line 66:		Line 68:
	** Known Issue: no payware content is available to the Developer Build at the current time.		** Known Issue: no payware content is available to the Developer Build at the current time.
	* '(?)' - Opens a help website in the system default browser.		* '(?)' - Opens a help website in the system default browser.

			The Trainz build number is displayed at the bottom right of the launch window.
			** Known issue: The build number is not rendered correctly on any platform.
			** Known issue: The displayed build number is currently a placeholder and should not be used.

	==Main Menu==		==Main Menu==
Line 81:		Line 87:
	** Known issue: TrainzUtil is not present in the current Developer Release build.		** Known issue: TrainzUtil is not present in the current Developer Release build.
	* 'Developer > Rebuild Content' - Rebuilds the Trainz Asset Database by scanning all installed content. Slow and rarely beneficial. Recommended as a last resort only.		* 'Developer > Rebuild Content' - Rebuilds the Trainz Asset Database by scanning all installed content. Slow and rarely beneficial. Recommended as a last resort only.
			* 'Developer > Show Logs' - Displays a log viewer window. Additional details can be found below.

	==Command-Line==		==Command-Line==
Line 143:		Line 150:
	* View Assets In New Window- Opens a new content window with a custom filter set to display the specified asset(s).		* View Assets In New Window- Opens a new content window with a custom filter set to display the specified asset(s).
	* View Asset In Game- For compatible asset types, this will open a viewer window which previews the specified asset. Only available when exactly one asset is selected. Currently compatible with Mesh Objects, Routes, and Sessions.		* View Asset In Game- For compatible asset types, this will open a viewer window which previews the specified asset. Only available when exactly one asset is selected. Currently compatible with Mesh Objects, Routes, and Sessions.
			* Edit Asset in Surveyor- For compatible asset types, this will open a Surveyor window which allows editing of the specified asset. Only available when exactly one asset is selected. Currently compatible with Routes and Sessions.
			* Open Asset in Driver- For compatible asset types, this will open a Driver window which allows driving of the specified asset. Only available when exactly one asset is selected. Currently compatible with Routes and Sessions.

	===Content Tasks===		===Content Tasks===
Line 148:		Line 157:
	Various actions in the Developer Release build, especially the above content management commands, will open a Task Window. This window will show the current activity and a progress bar. Further details can be revealed by clicking on the disclosure triangle to view an activity log. If the task completes successfully and the log has not been opened, the window will close automatically. Otherwise, the window will stay open and you may close the window after optionally reviewing the log.		Various actions in the Developer Release build, especially the above content management commands, will open a Task Window. This window will show the current activity and a progress bar. Further details can be revealed by clicking on the disclosure triangle to view an activity log. If the task completes successfully and the log has not been opened, the window will close automatically. Otherwise, the window will stay open and you may close the window after optionally reviewing the log.
	Closing the task window while the task is in progress will cancel the remainder of the task. Cancellation will not always occur immediately (some actions cannot be interrupted) and any changes already completed will not be rolled back.		Closing the task window while the task is in progress will cancel the remainder of the task. Cancellation will not always occur immediately (some actions cannot be interrupted) and any changes already completed will not be rolled back.
	* Known Issue: Once closed, it is currently impossible to review the diagnostic output of a task. It is expected that we will add a global task log in the future, similar to TS12's [[Content Manager]] log panel.

	Rows in the log can be selected (use modifier keys to allow multiple selection) and a content contextual menu can be displayed by right clicking. In cases where the log row relates to a specific asset, the command will operate on that specific asset. In other cases, the text of the log will be scanned for a KUID and the command will act upon the asset with that ID.		Rows in the log can be selected (use modifier keys to allow multiple selection) and a content contextual menu can be displayed by right clicking. In cases where the log row relates to a specific asset, the command will operate on that specific asset. In other cases, the text of the log will be scanned for a KUID and the command will act upon the asset with that ID.

			==Log Window==
			A global log viewer may be accessed via the "Developer > Show Logs" menu. This displays game logs equivalent to TS12's "Content Manager Log Panel". As per TS12, this logs all content operations that have occurred recently, allowing you to review the recent actions that you have taken and the success or failure of each action. The logs also include messages from the game runtime, including script messages, script exception logs, and resource load failures.
			** Known Issue: There is currently no mechanism for filtering or searching the logs.
			** Known Issue: There is currently no way to expand or contract parent entries to show/hide the children.
			** Known Issue: The icon on parent entries does not necessarily indicate the status of child entries.

	=Physics Testing Module (Stand Alone version)=		=Physics Testing Module (Stand Alone version)=

Tonyhilliam at 23:52, 21 May 2014

2014-05-21T23:52:19Z

← Older revision		Revision as of 23:52, 21 May 2014
Line 151:		Line 151:

	Rows in the log can be selected (use modifier keys to allow multiple selection) and a content contextual menu can be displayed by right clicking. In cases where the log row relates to a specific asset, the command will operate on that specific asset. In other cases, the text of the log will be scanned for a KUID and the command will act upon the asset with that ID.		Rows in the log can be selected (use modifier keys to allow multiple selection) and a content contextual menu can be displayed by right clicking. In cases where the log row relates to a specific asset, the command will operate on that specific asset. In other cases, the text of the log will be scanned for a KUID and the command will act upon the asset with that ID.

			=Physics Testing Module (Stand Alone version)=
			In addition to the developer builds of TANE being released during the Alpha phase, we will be releasing a stand alone version of the [[driving physics tools]]. This module will be integrated into TANE later on once the user interface is up and running. You can read more about the tools by clicking on the link above.

	=Discussion and Sharing=		=Discussion and Sharing=
	The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.		The Developer Release build is only available to TPC and TEG members, and active discussion between group members is encouraged on the TPC and TEG forums. Since the build is not available to other members of the Trainz community and most aspects of the build will have changed prior to the retail release of TANE, broad discussion of the build on the public forums is not encouraged. N3V asserts ownership of the Developer Release build and does not permit redistribution of the build.

Tonyhilliam: /* Directory Layout */

2014-05-16T01:37:56Z

Directory Layout

← Older revision		Revision as of 01:37, 16 May 2014
Line 14:		Line 14:

	* Windows: The "N3V Games\TANE" subfolder of the application local data folder is currently used. This typically defaults to "C:\Documents and Settings\username\Local Settings\Application Data\N3V Games\TANE".		* Windows: The "N3V Games\TANE" subfolder of the application local data folder is currently used. This typically defaults to "C:\Documents and Settings\username\Local Settings\Application Data\N3V Games\TANE".
			Note: If Windows cannot access your Docs folder, it will most likely choose the following path: C:\Users\<username here>\AppData\Local\N3V Games\TANE
	* Mac OS X: The "com.n3vgames.tane" subfolder of the containers folder is currently used. This typically defaults to "/Users/username/Library/Containers/com.n3vgames.tane". The "/Users/username/Library" folder is hidden by default, and must not be confused for the "/Library" folder. If in doubt, hold down the "option" key and use the "Go > Library" menu from Finder.		* Mac OS X: The "com.n3vgames.tane" subfolder of the containers folder is currently used. This typically defaults to "/Users/username/Library/Containers/com.n3vgames.tane". The "/Users/username/Library" folder is hidden by default, and must not be confused for the "/Library" folder. If in doubt, hold down the "option" key and use the "Go > Library" menu from Finder.