View source for Basemapz

The Basemapz program is a stand-alone application developed by ModelerMJ. It is supplied with Trainz Model Railroad 2017 and is also available from [http://www.dhobh.net/trainz the author's website].

'''This page covers Version 1.0.'''
<!--
**** WARNING TO ANYONE EDITING THIS PAGE ****
Do not change the text of the section titles.
The software links to these sections to provide help.
If titles are changed, that functionality will no longer work.
-->
=<span style="color:blue;">'''Introduction'''</span>=
This document describes Version 1.0 of Basemapz, a Windows™ application that allows you to quickly transfer a model railroad track plan image into the Trainz™ Railroad Simulator environment. Basemapz is compatible with Windows 7 through 10; and with Trainz versions TS2009, TS2010, TS12, TS12-SP1 and T:ANE.

Using an easy-to-understand process, Basemapz produces a complete Trainz Route containing the required arrangement of baseboards, plus a collection of auto-positioned basemap carrier objects that each contain the section of the track plan image that falls on one baseboard.  The output of Basemapz is placed in a series of folders that can be imported into Trainz Content Manager in a single operation, where the Route is then immediately available for editing in Surveyor.

Here are the basic steps in the process:

* Start by acquiring a ''track plan image''.  This can be done by scanning a plan out of a book or magazine that you own, or by downloading a track plan image from one of many web sites that provide them.

* Once you have the image, it must be ''cropped'' as closely as possible around the boundaries of the benchwork so that it can be accurately scaled into the Trainz environment.

* Then, if the image is a bit crooked (as often happens when it is scanned), it needs to be ''deskewed'' by rotating it just a tiny bit so that the edges are straight in the vertical and horizontal directions; this makes the images line up nicely with the terrain grid in Trainz.

* Finally, '''''save the image in a folder all by itself'''''; this is ''extremely important'' if you don’t want to lose work.

* Next, you need to gather some information about the track plan.
** You need to know what ''scale'' it was designed in – HO, N, and so on.
** You also need to know the ''overall dimensions'' of the plan, in feet and inches.

* Once you have this information, you can load the image into Basemapz; specify the scale of the plan; specify its size in the X and Y directions; and ''generate a preview'' that shows how the plan will look when it is exported to Trainz.
** If something doesn’t look right, you can make adjustments and generate as many previews as needed until you are satisfied with the results.

* When the preview is satisfactory, a single button click brings up a dialog that allows you to specify information that Trainz needs to properly process the objects that are exported by Basemapz.  This includes:
** A ''starting Content ID number'', which is used and incremented for each basemap produced.
** Your ''Trainz User ID'', ''author name'', and ''contact information''.
** Any ''license terms'' you want included.
** And, finally, whether you want a complete Trainz Route to be generated, or just the basemaps.

* When you enter this information and click OK at the bottom of the dialog, Basemapz creates a complete ''Trainz Route'' of the required size, auto-generating all the binary “map-file” components (if you specified that you wanted a Route to be generated).
** Terrain is all flat.
** The 5M grid is always used.

* Basemapz also generates a collection of ''basemap carrier objects'' that each contain the section of the track plan image that falls on one baseboard.
** These carriers are auto-positioned in the route as appropriate, at a height of 0.1 meters above the terrain, and are placed on their own (locked) layer.

* Additional layers are also created to contain typical Model Railroadz items like digholes, fascia, and supports; as well as the floor, walls and ceiling.

* All this is exported to a series of sub-folders within a single main folder, complete with “config.txt” and thumbnail files, the collection of which can then be imported straight in-to Content Manager in a single operation.

* The route can then be opened immediately in Surveyor, and track and other items can be placed in the usual way, using the basemap images as a guide.
** It is highly recommended that you turn on the '''Process Objects Behind Camera''' option (in T:ANE) to ensure the basemaps stay visible as you pan around.

* When the basemaps are no longer needed, they must be deleted to avoid violating the copyright of the track plan image owner.

<span style="color:darkgreen;">'''If any of this sounds complicated, don’t worry – it’s actually very simple, and each of these steps will be explained in detail in later sections of this document.'''</span>

==<span style="color:blue;">Legal Considerations</span>==
Model Railroad Track Plan Images are '''copyrighted material''', and as such there are restrictions as to what you can do with them.  Based on the concept of '''fair use''', it is generally accepted that you can use these plans as an aid in constructing your own version of a given layout, and that you are allowed to make copies and/or derivative versions of the plans for that purpose only.

In the case of Basemapz, the software accepts a track plan image that you must acquire in a legal fashion – for example, by scanning it from a book or magazine you own, or by downloading it from a web site that permits you to do so.  Basemapz then creates a '''derivative''' of the plan by rescaling it and breaking it up into pieces that can be positioned over the baseboards within a Trainz route, thereby serving as a guide that enables you to construct your own version of the route.  Thus, the spirit of fair use is preserved.

'''When you are done constructing the route, it is your obligation to delete the basemap objects produced by Basemapz''', so that copyrighted track plan images are not distributed to others when you share or sell the route.

==<span style="color:blue;">If You Have Trouble</span>==
If you are having difficulty with any aspect of Basemapz, please post your questions in the Trainz forums or send the author a PM from there.  The Trainz community is full of friendly people who are always happy to help each other enjoy this wonderful hobby of ours.

=<span style="color:blue;">'''Important Things to Know Before You Start'''</span>=
When Basemapz exports a set of basemaps and a route to Trainz, it will ask you to supply certain information that might be foreign to newcomers to Trainz.  This includes something called a ''KUID'', plus a numeric Trainz ''User ID'' and an ''Author Name''.  This is information is easy to find if you know where to look; the following sections will help you.

==<span style="color:blue;">KUIDs and Content IDs</span>==
A '''KUID''' is an identifier uniquely allocated to each item of content created for Trainz, similar to a bar code. Typically, these identifiers are created and used internally by Trainz, so understanding the exact format is not necessary for most users.

The part of the KUID that we're interested in for Basemapz is the ''Content ID'' portion.  Look at the example KUID below.

:<KUID2:171456:'''38001''':1>

The middle number, '''38001''' in the above example, is the '''''Content ID'''''. This is a number that the content creator (you) assigns to each creation to uniquely identify it. The combination of a creator's ''User ID'' and the ''Content ID'' form a unique asset identifier (the KUID), which prevents conflicts with assets created by others.

The number used as a Content ID must be a positive integer in the range between 1 and 2147483648.

This number has no special meaning beyond helping to form a unique identifier for the asset.  There are "recommended ranges" for certain Content IDs, with values from 20000 to 20999 typically being used for Routes and values from 60000 to 60999 typically being used for Miscellaneous Content (which basemaps are considered to be); Basemapz adheres to these two conventions by default, but you are of course free to choose whatever numbers you wish.

Full details about KUIDs are provided [http://online.ts2009.com/mediaWiki/index.php/KUID here] for interested parties.

==<span style="color:blue;">Finding Your User ID and Author Name in T:ANE</span>==
To locate your User ID and Author Name in T:ANE, begin by starting the T:ANE software.  In the startup screen, choose '''Trainz Settings'''.

[[File:Basemapz_UserID04.png]]

In the ''Settings'' dialog, click the '''Internet''' tab.

[[File:Basemapz_UserID05.png]]

Your '''Author Name''' is shown in the ''Username'' field, outlined in green in the example above.

Now click the '''Dev''' tab.

[[File:Basemapz_UserID06.png]]

Your '''User ID''' is shown in the ''User ID'' field, outlined in blue in the example above.

'''''NOTE:''''' Your User ID and Author Name will be different from what is shown here -- the values displayed here are just an example to help you find the information.  Always use the information that has been assigned to you or that you have chosen.

'''Write these values down''' so you can use them in Basemapz later.  You'll only have to enter them once; Basemapz will remember your entries and will automatically display them again on subsequent uses.

==<span style="color:blue;">Finding Your User ID and Author Name in TS12 and Earlier</span>==
To locate your User ID and Author Name in TS12 and earlier versions of Trainz, begin by starting the Trainz software.  In the startup screen, choose '''Content'''.

[[File:Basemapz_UserID01.png]]

''Content Manager'' will open.  On the ''File'' menu, choose '''Settings'''.

[[File:Basemapz_UserID02.png]]

In the ''Settings'' dialog, click the '''Internet''' tab.

[[File:Basemapz_UserID03.png]]

Your '''User ID''' is shown in the ''User ID'' field, outlined in blue in the example above.  Your '''Author Name''' is shown in the ''Planet Auran Username'' field, outlined in green in the example above.

'''''NOTE:''''' Your User ID and Author Name will be different from what is shown here -- the values displayed here are just an example to help you find the information.  Always use the information that has been assigned to you or that you have chosen.

'''Write these values down''' so you can use them in Basemapz later.  You'll only have to enter them once; Basemapz will remember your entries and will automatically display them again on subsequent uses.

=<span style="color:blue;">'''Recommended Additional Software'''</span>=
'''IrfanView''' is absolutely invaluable when it comes to translating track plan images into Trainz.  This application allows you to resize, crop and de-skew images, all of which are essential operations when attempting to use a scanned image of a track plan.

You can download IrfanView for free from the official site at [http://www.irfanview.net/ http://www.irfanview.net/]; be sure to choose the version (32- or 64-bit) that is appropriate for your system.

=<span style="color:blue;">Basemapz Installation, Startup, Exiting and Removal</span>=
Basemapz is distributed by N3V as a standalone installer; if you download it from my web site, you will instead get a single Microsoft Installer file named '''BasemapzSetup.msi'''.  In either case, after you download or obtain this file, find it (i.e. in Windows Explorer) and double-click it.

 [[File:Basemapz_Install01.png]]

Don’t worry if the file size or date are different than the ones shown above; that image is just an example to help you make sure you are locating the right file.

==<span style="color:blue;">Installation</span>==
After you double-click the MSI file, there may be a short pause; please '''be patient''' while Windows gathers information it needs to perform the installation.  The first installation screen will then be displayed, and will appear similar to the following example.

[[File:Basemapz_Install02.png]]

When you are ready to proceed, click '''Next'''.  The second installer screen will be displayed, and will appear similar to the following example.

[[File:Basemapz_Install03.png]]

It is highly recommended that you leave the preset destination folder unchanged, but you are of course free to select a different installation location as you see fit.

When the proper destination location is shown, click '''Next'''.  The third installer screen will be displayed, and will appear similar to the following example.

[[File:Basemapz_Install04.png]]

When you are ready to proceed, click '''Next'''.  The fourth installer screen will be displayed, and will appear similar to the following example.

[[File:Basemapz_Install05.png]]

At this point, installation may pause and a ''User Account Control'' (UAC) dialog may be displayed that appears similar to the following example.

[[File:Basemapz_Install06.png]]

The “unknown publisher” is ModelerMJ, so it’s safe to click '''Yes'''.

Installation will then proceed, with some progress bars being displayed very rapidly.

When installation completes, the final installer screen will be displayed and will appear similar to the following example.

[[File:Basemapz_Install08.png]]

Click '''Close'''.  Now look at your desktop and locate the shortcut for Basemapz; it will look similar to the following example.

[[File:Basemapz_DesktopIcon.png]]

==<span style="color:red;">'''Anti-Virus Considerations'''</span>==
I have discovered that Symantec Endpoint Protection considers TrainzMeshImporter.exe (included as part of the Basemapz installation) to be a virus, and will summarily remove it from your system.  If you have this anti-virus product installed, watch for the message stating that TrainzMeshImporter.exe is unsafe and has been removed; click on the message for details, then restore the file; an exception should automatically be created for the file as well.  TrainzMeshImporter.exe is a vital component of Basemapz and the software will not run without it.

==<span style="color:blue;">Startup</span>==
To start Basemapz, locate the shortcut (shown above) on your desktop and double-click it.  Or, open the Windows ''Start'' Menu, select '''All Apps''', find Basemapz in the alphabetized list, and click it once.

[[File:Basemapz_StartMenuEntry.png]]

Either way, Basemapz will open, and will initially appear similar to the example below.

[[File:Basemapz FirstStartup.png]]

On first startup, Basemapz will search for the largest display in your system, and will then position itself centered on that monitor.  You can then move the application window around, maximize it, resize it or minimize it in the usual way.  When you close Basemapz, it will remember the position and size of its main window, and will reappear at that same location and with the same size on the next startup.

As you use Basemapz, it also remembers all the data you enter and all the selections you make, and this information will automatically be re-displayed when you start Basemapz the next time.

==<span style="color:blue;">Exiting</span>==
To close Basemapz, click the '''Exit''' button at the bottom right corner of the Basemapz window.

==<span style="color:blue;">Removing the Program</span>==
To remove Basemapz from your system, begin by opening ''Windows Control Panel''.  In Windows 10, do this by right-clicking the Windows ''Start'' Button, then selecting '''Control Panel''' from the menu that appears.

[[File:Basemapz_Removal01.png]]

When Windows Control Panel opens, select '''Programs and Features'''.  You may want to use ''Small Icons'' view to make it easier to locate this applet.

[[File:Basemapz_Removal02.png]]

In the ''Programs and Features'' dialog, find Basemapz in the list, then click '''Uninstall'''.

[[File:Basemapz_Removal03.png]]

A confirmation dialog will be displayed.  Click '''Yes'''.

[[File:Basemapz_Removal04.png]]

A status message will then be displayed, similar to the following example:

[[File:Basemapz_Removal05.png]]

At this point, the program removal process may pause and a ''User Account Control'' (UAC) dialog may be displayed that appears similar to the following example.

[[File:Basemapz_Removal06.png]]

Again, the “unknown publisher” is ModelerMJ, so it’s safe to click '''Yes'''.

Program removal will then proceed, with some progress bars being displayed very rapidly.

After program removal is complete, the Basemapz entry will be removed from the list in the ''Programs and Features'' dialog; you can then close that dialog by clicking the '''X''' at the upper right corner.

=<span style="color:blue;">Obtaining Track Plan Images</span>=
Track Plan Images are available from a wide variety of sources.

* [http://mrr.trains.com/ Model Railroader Magazine] is a popular source of plans.  If you are a subscriber, you can download plans from their [http://mrr.trains.com/track-plan-database Track Plan Database].

* Model Railroader [http://mrr.trains.com/magazine/special-issues Special Issues] are also a great source of plans.

* The Model Railroader 75 Year Collection DVD set is a great source of track plans (and of course a wealth of other information).  Unfortunately, this product was discontinued c. 2011-2012 (verified with a phone call to Kalmbach), but it may still be available (albeit used or in alternate formats) from other sources.

* Kalmbach Publishing has issued many track plan collection books over the years.  These are available [https://kalmbachhobbystore.com/catalog/special-issues directly from the publisher] and can also be found on [https://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=model+railroad+track+plans&rh=i%3Aaps%2Ck%3Amodel+railroad+track+plans Amazon.com].

* Use Google and search for [https://www.google.com/?gws_rd=ssl#q=model+railroad+track+plans Model Railroad Track Plans], then follow the links in the results; or [https://www.google.com/search?q=model+railroad+track+plans&biw=1920&bih=1091&tbm=isch&tbo=u&source=univ&sa=X&ved=0ahUKEwi_8K-bhavQAhXCxFQKHbDLB2UQsAQIIQ turn on 'images'] and you will see many pictures of plans.

* Scan the images from a magazine or book that you own.  This is a manual process, of course, and will be discussed in the next section.



=<span style="color:blue;">Preparing Track Plan Images for Import</span>=
In this section I will describe the techniques that I use to acquire a track plan image from a magazine and prepare it for use with Basemapz.  This sequence of operations is not the only way to achieve this goal, and feedback from the Trainz community is always welcome.  If you have a good way of importing track plans that you'd like to share, please PM me (ModeerMJ) at the [http://forums.auran.com/trainz/forum.php? Trainz Forums] so we an exchange the appropriate information.

==<span style="color:blue;">Find and Scan a Track Plan Image</span>==
The example track plan I will use in this section is the N-Scale Fox River Grove, designed by Frank Stastny, which appeared in the February 1975 issue of Model Railroader magazine.

[[File:Basemapz_MRCover_Feb1975.jpg]]

From that magazine I scanned the entire page containing the track plan image, at 600 DPI.  This gave me a JPG file that looked like this.

[[File:Basemapz_MR_FRG_300-15.jpg]]

==<span style="color:blue;">Perform a Rough Crop</span>==
I then loaded the JPG into IrfanView, and drew a rough selection rectangle around the part of the page image that actually contained the track plan.  Notice that I left quite a bit of extra room around the outside of the track plan - right now all I want to do is isolate the plan so I can straighten it.  Later on, we'll crop it right to the edges of the bench work.

[[File:Basemapz_RoughSelectionRectangle.png]]

Finally, I selected '''Edit -> Crop Selection (Cut out)'''.  This gave me the area of the page containing the track plan, with some extra room around the outside.

[[File:Basemapz_InitialCutOut.png]]

==<span style="color:blue;">Straighten the Image</span>==
Let's now take a closer look at this image - we need to determine if the scan is straight, or if it is rotated (skewed) in either the clockwise or counter-clockwise direction.  As you can see, in this case the track plan is rotated just a tiny bit off-axis in the clockwise direction.

[[File:Basemapz_ScanIsRotated.png]]

IrfanView makes it very easy to correct this.  Begin by going to '''Image -> Custom/Fine Rotation'''; this will present a dialog box similar to the following example.

[[File:Basemapz_FineRotationDialog.png]]

Note the Angle field; this is where you will specify the amount of rotation to be applied to the image.

* '''Use very small values.'''  Typically the rotation needed is less than 1 degree, so type in the values you want rather than using the up-down arrows to the right of the field.
* '''Try tenths of a degree.'''  For example, enter '''0.1''' to rotate the image clockwise by one tenth of one degree.
* '''Use negative angles''' to rotate the image counter-clockwise.  For example, enter '''-0.1''' to rotate the image counter-clockwise by one tenth of one degree.
* It will take a bit of experimenting to determine the amount of rotation needed to square up the image.
** To test your experiments, enter them in the '''Angle''' field and click '''OK'''.
** If the rotation isn't correct, type '''Ctrl+Z''' to undo your experiment, then go to '''Image -> Custom/Fine Rotation''' and try again.

In this case I ultimately determined that I needed to rotate the image 0.4 degrees in the counter-clockwise direction, so I entered '''-0.40''' into the '''Angle''' field.  Once I did that, the '''New Image''' part of the dialog changed to show a preview of what the image would look like with that amount of rotation applied.  If you look closely, you'll see that the bench work area of the plan is now square with the borders of the preview area.

[[File:Basemapz_FineRotationDialog2.png]]

Click '''OK''', and the rotated image appears in the main IrfanView window.  As you can see, the track plan part of the image is now nicely squared up.

[[File:Basemapz AfterFineRotate.png]]

==<span style="color:blue;">Perform the Final Crop</span>==
Now we can crop the image to its final dimensions.  Draw a selection rectangle that fits around the edges of the bench work as exactly as possible.  Note that you can drag the edges of this rectangle after it is drawn, to adjust the fit.

[[File:Basemapz_CloseCrop.png]]

Once again, select '''Edit -> Crop Selection (Cut out)'''.  This will give you the area of the page containing the track plan with no extra space around it.

[[File:Basemapz_FinalCrop.png]]

Notice how the edges of the track plan bench work line right up with the edges of the IrfanView main window.

==<span style="color:blue;">Save the Image in its Own Folder</span>==
Finally, we need to save this file where we can find it later.  Start by selecting '''File-> Save As'''.  This will bring up a '''Save Picture As...''' dialog.  <span style="color:red;">'''DO NOT CLICK SAVE YTT!!!'''</span>

Before we actually save the file, we need to create a folder that will contain the image.  Basemapz requires that the input image be in its own folder, so it has a known place to create the Trainz files that you will import into Content Manager later on.


<span style="color:red;font-size:200%">'''THIS IS EXTREMELY IMPORTANT - DO NOT SKIP THIS STEP.'''</span>


Create a new folder someplace where you can find it later.  In this case I'll create a folder named '''Fox River Grove''' within the '''Documents''' folder.

[[File:Basemapz_NewFolderForImage.png]]

Finally, save the image in this new folder, with an appropriate name.  I'll use '''FoxRiverGrove.jpg'''.

[[File:Basemapz_SavingFile.png]]

==<span style="color:blue;">Image Preparation Complete</span>==
That's it.  The track plan image is now ready for import into Basemapz.

'''Note:''' If you want to clean up the image - for example, to remove extraneous text and other artifacts that were present on the scanned page - load the image into Paint (or your favorite image editor) and do it now.

<span style="color:red;">'''Always save your changed version under a new name so that, if anything goes wrong, you will still have the original to fall back on.'''</span>



=<span style="color:blue;">Importing and Previewing Track Plan Images</span>=
We're getting closer - it's now time to fire up Basemapz and convert your track plan image into a Trainz route.

Start by launching Basemapz, using the icon on your desktop:

[[File:Basemapz_DesktopIcon.png]]

Basemapz will then open.

==<span style="color:blue;">The Basemapz Application Window</span>==
If this is the first time it was started, all the fields will initially be blank; the track plan dimensions will be set to represent the good old 4x8 sheet of plywood; and the scale will be set to HO.  The screen will appear similar to the following example.

[[File:Basemapz_FirstStartup.png]]

By default, Basemapz will seek out the largest monitor in your system and will center itself there, full-height.  You can of course move and resize the window as you wish, and minimize or maximize it as well.  When you close Basemapz, it will remember where it was on your screen(s), and what its size was as well, and will restore itself to the same location and size on the next startup.

==<span style="color:blue;">Selecting the Track Plan Image</span>==
To import the track plan image, click the '''Browse''' button at the top right.  You'll be presented with an '''''Open File''''' dialog titled 'Select Layout Image'.  Navigate to the folder where you stored the track plan that you want to work with.

[[File:Basemapz_SelectLayoutImage.png]]

Select the plan and click '''Open'''.

==<span style="color:blue;">Setting the Scale and Size of the Track Plan</span>==
Now, in Basemapz, set the scale and the size of the plan in the fields across the top.

* Select the scale first.  In the case of my example layout, the plan in is N Scale, so I selected that from the drop-down.
* Set the size in the X (horizontal) direction.  In the case of my example layout, the plan measures 12 feet in this direction, so I used the up-down arrows to select 12.
* Set the size in the Y (vertical) direction.  In the case of my example layout, the plan also measures 12 feet in this direction, so I used the up-down arrows to select 12.

When I was done, the fields at the top of the dialog looked like this:

[[File:Basemapz_FieldsSet.png]]

==<span style="color:blue;">Previewing the Track Plan as it will Appear in Trainz</span>==
Now we are ready to preview the track plan as it will appear in Trainz.  To do this, click '''Render Route Image'''.  A progress bar will be displayed while the preview is being generated, after which the preview will be displayed.  Here's what that looks like for my example layout.

[[File:Basemapz_PreviewFRG.png]]

At the bottom, Basemapz shows you the number of baseboards that are required in each direction, and the total number of baseboards as well.

For my example layout, only 1 baseboard is needed; in the case of a very large layout, more baseboards will be required and these numbers will be different.

==<span style="color:blue;">Ready for the Next Step</span>==
<span style="color:green;">'''We're now ready to export the track plan to Trainz, as explained in the following section.'''</span>



=<span style="color:blue;">Exporting to Trainz</span>=
To begin the export process, click the '''Generate Basemaps''' button near the lower right of the Basemapz main window.  This will cause the '''Basemapz Export Parameters''' dialog to be displayed, which will appear similar to the following example.

[[File:Basemapz_ExportDialog.png]]

The first time you use this function, all the fields will be blank.  The example above shows how the dialog looks after the information for my example layout has been filled in.

==<span style="color:blue;">The Export Parameters Dialog</span>==
Let's go over the fields in this dialog.

* '''Starting Content ID''' - This is where you enter the Content ID that will be used for the first basemap that is generated for your track plan; Basemapz uses a default value of '''60000''' here.  One basemap is generated for each baseboard in a Trainz route, and when a track plan requires more than 1 basemap, this number will automatically be incremented for each additional basemap required.  In any case, this number will be combined with your Trainz User ID to create something called a KUID for each generated basemap.  If you'd like to learn more about what a KUID is and how it is used, please check out [http://online.ts2009.com/mediaWiki/index.php/Basemapz#KUIDs_and_Content_IDs this link].

* '''Trainz User ID''' - This is a number that is assigned to you by N3V Games when you register your copy of Trainz.  For information on how to find this number, look [http://online.ts2009.com/mediaWiki/index.php/Basemapz#Finding_Your_User_ID_and_Author_Name_in_TS12_and_Earlier here] for TS12 and earlier, or [http://online.ts2009.com/mediaWiki/index.php/Basemapz#Finding_Your_User_ID_and_Author_Name_in_T:ANE here] for T:ANE.

* '''Author Name''' - This is a name you pick when you register your copy of Trainz.  This name gets used in the Trainz forums and also goes into the configuration file for any assets you create - in this case, the basemaps and route that are generated by Basemapz.  For information on how to find this name, look [http://online.ts2009.com/mediaWiki/index.php/Basemapz#Finding_Your_User_ID_and_Author_Name_in_TS12_and_Earlier here] for TS12 and earlier, or [http://online.ts2009.com/mediaWiki/index.php/Basemapz#Finding_Your_User_ID_and_Author_Name_in_T:ANE here] for T:ANE.

* '''Organization''' - If you're just doing this for fun, you can leave this blank.  Otherwise, enter the name of your company, hobby group and so on into this field.

* '''Contact E-Mail''' - If you want people to be able to e-mail you about content you've created, enter an e-mail address here where you can be contacted.

* '''Contact Website''' - If you have a website related to Trainz Content that you'd like people to visit, enter the URL (web site address) here.

* '''License Text''' - This area lets you spell out the terms of use of the basemaps and route being created.  At a minimum, you should always give proper attribution to the author and/or publisher of the track plan; in the example image, I've credited Kalmbach Publishing.  You may also want to specify how your content can be used, and whether there are any special requirements for its use.  Again, in the example above, I've stated that the image can only be used to build a route, and that it must be deleted before the route is published.

* '''Also create a basic Trainz Route''' - If you want Basemapz to create a complete Trainz route for you, with the required arrangement of baseboards and all of the generated basemaps pre-positioned, then leave this check box checked.  If you want to generate only the basemaps, and then position them manually in a Trainz route you create on your own, then clear this check box.

* '''Trainz Route Content ID''' - This is where you enter the Content ID that will be used for the Trainz route itself, when one is generated; Basemapz uses a default value of '''20000''' here.

<span style="color:red;">'''When selecting Content IDs, be sure to pick numbers that will not overwrite other content you have already created (unless of course you want to do so).'''</span>

We're now ready to actually perform the export operation.  To kick things off, click '''OK''' at the bottom of the '''Basemapz Export Parameters''' dialog.  When you do so, the dialog will be removed from the screen, and a progress bar will appear in the main Basemapz window as the export takes place.

==<span style="color:blue;">Export Complete</span>==
When export is complete, you'll see a message similar to the following example.

[[File:Basemapz_ExportComplete.png]]

Click '''OK'''.  Now look at the bottom of the Basemapz window, and you'll see a text field containing the location of the folder where all of the exported data was placed.

[[File:Basemapz_ExportResults.png]]

To the right of this field, click '''Copy''' to put this information on the Windows Clipboard.

==<span style="color:blue;">Import the Route into T:ANE and TMR17</span>==
Start T:ANE or TMR17 and, from the Trainz Launchpad, select '''Manage Content'''.

[[File:Basemapz_TANELaunchPadManageContent.png]]

This will cause Content Manager to come up, which is where you will import the data that was just created by Basemapz.

[[File:Basemapz_TaneContentManager.png]]

On the '''File''' menu, select '''Import Content Folder'''.

[[File:Basemapz_TaneImportContentFolder.png]]

This will cause a ''Select a Folder'' dialog to appear.  Right-click in the '''Folder''' field at the bottom, and select '''Paste''' from the menu that appears; this will place the location of your Basemapz export files, which you just copied to the clipboard from within Basemapz, into the ''Select a Folder'' dialog.

[[File:Basemapz_TaneImportLocationPasted.png]]

Now press '''Enter''', and Trainz will import your files.

[[File:Basemapz_TaneInstallingContent.png]]

When this operation is complete, you'll get a message similar to the following:

[[File:Basemapz_TaneTaskComplete.png]]

Now go back to the Trainz Launchpad, and select '''Start Trainz'''.

[[File:Basemapz_TANELaunchPadStartTrainz.png]]

Wait for the main Trainz ''Select Route'' screen to appear, and you'll see your new route there, ready to edit.

[[File:Basemapz_TaneSelectRoute-50.png]]

Click '''Edit Route''' at the bottom, then wait as Trainz loads your route into Surveyor.

On initial load, you will find yourself very close-in at the center of the map.

[[File:Basemapz_TaneInitialView-75.png]]

Use the mouse wheel to zoom out until the whole plan is visible.

[[File:Basemapz_TaneFirstOverview-50.png]]

You'll notice that the track plan is rotated counter-clockwise by ninety degrees.  This is because Trainz 'North' is actually to the left when you start a route; to keep the top of the plan to the North as you might expect, Basemapz has pre-rotated the plan for you to match the North-South alignment in Trainz.

You'll also notice that the track plan initially looks 'washed out', and that the colors are not very distinct.  That's easy to fix, and we'll take care of it in the next section.

==<span style="color:blue;">Import the Route into TS12-SP1 and Earlier</span>==
Start Trainz.  From the Trainz Launchpad, select '''Content'''.

[[File:Basemapz_UserID01.png‎]]

This will cause Content Manager to come up, which is where you will import the data that was just created by Basemapz.

[]

On the '''File''' menu, select '''Import Content'''.

[]

This will cause a Folder Browser dialog to appear.  Right-click in the Location field at the bottom, and select '''Paste''' from the menu that appears; this will place the location of your Basemapz export files, which you just copied to the clipboard from within Basemapz, into the Open File dialog.

[]

Now press '''Enter''', and Trainz will import your files.

[]

When this operation is complete, you'll get a message similar to the following:

[]

On the Content Manager '''File''' menu, select '''Start Trainz'''.

[]

Wait for the main Trainz screen to appear, and you'll see your new route there, ready to edit.

[]

Click '''Edit Route''' at the left side, then wait as Trainz loads your route into Surveyor.  Once it's loaded, pan around a bit; here's an example of what the route looks like at this stage.

[]

In the case of TS12 and earlier, no special adjustments are needed, and the route is immediately ready to edit, as we'll see in the next section.

=<span style="color:blue;">'''Tips for Building Your Route'''</span>=
In this section, we'll look a bit closer at what was actually generated, and talk a bit about how to use the basemaps to lay track and position other objects.  We'll be using examples from T:ANE SP1, since it is most reflective of TMR17 at the time this is being written.

==<span style="color:blue;">In T:ANE and TMR17, Fix the Environment Colors</span>==
As noted earlier, when you first load a Basemapz-generated route into T:ANE, the track plan imagery will appear 'washed out'.  This is due to differences n the way that T:ANE interprets environmental lighting values versus TS12.  This is easy to fix; start by selecting '''Edit Environment''' on the Surveyor '''Main Menu'''.

[[File:Basemapz_TaneEEMenu.png]]

This will bring up the '''Environment''' settings dialog.  At the upper right, click the '''Reset Colors''' button.

[[File:Basemapz_TaneEnvDialog-75.png]]

Click the Check Mark in the next dialog to confirm that you want to do this.

[[File:Basemapz_TaneResetYesNo2.png]]

Then click the 'X' at the upper right of the ''Environment'' settings dialog, and the track plan image should now appear crisp and sharp as expected.

[[File:Basemapz_TaneDetail-75.png]]

'''Be sure to save the route now to preserve these changes.'''

==<span style="color:blue;">Be Aware of the Auto-Generated Layers</span>==
When Basemapz creates a route, it also creates several layers that are commonly used when creating Model Railroadz.  To see these layers, choose the Layers icon at the right side of Surveyor.

[]

The layers created by Basemapz all start with the letters 'TMR'.  The first of these layers, 'TMR-Basemaps', contains all the basemap objects created by Basemapz, and is already set as locked so that you can't accidentally move the basemap objects around.  By having the basemap objects on their own layer, you can easily hide and show them all at once as you work on your route.

As their names imply, the other layers are meant to contain other types of objects specific to Model Railroadz.  These layers are meant as a suggested starting point and you are, of course, free to add your own and even change the ones that are already provided; do whatever works best for you.

'''The main thing to be aware of is to always be sure that the proper layer is active when you are working with a particular kind of object.'''  Paying attention to this as you add objects will make your life much easier later on when you want to work with them again.

==<span style="color:blue;">Lay Track from Directly Overhead</span>==
When you are laying tack (and placing other objects), it is important to be looking straight down at the track plan.  If you are looking at the plan from an angle, you will quite likely end up missing the lines.

Here's an example of how I laid a few quick sections of track.

[[File:Basemapz_TaneTrackLaid-75.png]]

==<span style="color:red;">'''SAVE YOUR WORK OFTEN'''</span>==
Whenever you are working in Trainz doing anything in Surveyor, be sure to SAVE YOUR WORK often.  Failing to do so can cause you to lose your work if the software stops working for some reason.

To save your work, select Save on the Surveyor Main Menu.

[]