ORTS Include function for groups of wags and engs

[R. Steele]

From the manual [ section 8.14.1 page 123 ]:
"This use of the “Include” command can be extended to apply to sections of groups of .wag or .eng files that the user wishes to replace by a specific block of data – the parameters can be provided by a text file located outside the usual MSTS folders; e.g. brake parameters."

Can anyone provide me with a screenshot of a working example of how they have set this up. I believe I understand how to use include files within the OpenRails folder in a specific wag or eng root folder, but I'm having a little difficulty visualizing how the above paragraph would work.

A specific example would be how to set up OR coupler parameters or brake parameters for all the wagons in an OR profile.

Thanks in advance. Gerry

[muskokaandtahoe]

For one of Derek Miller's steam locomotives. Please make note of the path used for the include statement for couplers. All of the other .inc files are in the same directory as the .eng file.

For my setup, ALL of Derek's GS-2 locomotives use the same include statements.

SIMISA@@@@@@@@@@JINX0D0t______

Wagon ( spmsts4410-1
WagonShape ( spmsts4410-1.s )
Freightanim ( SP-GS2-Crew1.s 1 1 1)
Adheasion ( 0.3 0.76 0.63 0 )

Include ( "SP_GS-2_Mesh.inc" )
Include ( "SP_GS-2_Locomotive_Weight.inc" )
Include ( "..\\Common_Fleet_Stds\\US\\Std_Steam_Locomotive_B ar_&_Coupler.inc" )
Include ( "SP_GS-2_LOCOMOTIVE_BRAKES.INC" )
Sound ( "GS2eng.sms" )
Include ( "SP_GS-2_Lights.inc" )
)

Engine ( spmsts4410-1
COMMENT ( "The following block of data is retained in this file to allow cusomizing the FX of each locomotive. " )
COMMENT ( "For each FX, you may edit the numerical value in the thrd line of numbers." )
COMMENT ( "DO NOT edit any other numbers!" )
Effects
(
SteamSpecialEffects
(
WhistleFX
(
0 4.84 -6.943
0 1 0
0.1
)

SafetyValvesFX
(
0.0 4.8 -5.763
0 1 0
0.2
)

StackFX
(
0 5.05 1.387
0 1 0
0.17
)

CylindersFX
(
-1.496 0.38 1.527
-1 0 -0.5
0.15
)

CylindersFX
(
1.496 0.38 1.527
1 0 -0.5
0.15
)
)
)

Include ( "SP_GS-2_Power.inc" )
COMMENT ( " For variable power performance copy any line from the above .inc file and paste below this comment, then ")
COMMENT ( "edit value as desired. Use at your own risk." )


COMMENT (" You may edit the values on the next two lines to have a customized effect appear on this locomotive." )
SteamSmokeUnitsPerPoundOfFuel ( 4.5 )
SteamMaxSmokeUnitsReleaseRate ( 10 )

Include ( "SP_GS-2_Air_Compressor_&_Resevoir.inc" )
Include ( "SP_GS-2_Independent_Brake_Control.inc" )
Include ( "SP_GS-2_Train_Brake_Control.inc" )
Include ( "SP_GS-2_Misc_Engineer_Control.inc" )
Include ( "SP_GS-2_Misc_Fireman_Control.inc" )

CabView ( GS-2.cvf )
HeadOut ( 1.74 3.58 -13.10 )
Include ( "SP_GS-2_Engine_Controllers.inc")

comment ( fire temp, fire mass, water mass, boiler pressure,
tender water, tender coal, smoke quantity,
fire condition, fuel quality )
EngineVariables( 950 1227 11297 250 194555 42000 200 1 1 )

Sound ( "GS2cab.sms" )

Name ( "SP 4-8-4 GS-2 #4410" )
Include ( "SP_GS-2_Text.inc" )
)

[muskokaandtahoe]

Here is a .wag file for one of Tim Muir's USRA boxcars. Do note the path used for each include statement as it's rather important to grasp exactly what I'm doing.

For myself, all of Tim's boxcars are set up this way.

SIMISA@@@@@@@@@@JINX0D0t______

Wagon ( XM_MILW_702584_MT

WagonShape ( MILW_USRA_702584.s )

Include ( "..\\Common_Model_stds\\US\\USRA_SS_Boxcar_Tim_Mui r_Model\\XM_USRA_SS_Mesh_Defined.inc" )
Include ( "..\\Common_Fleet_Stds\\US\\Std_Type_Coupler_Gener ic_Draft_Gear.inc" )

Adheasion ( 0.2 0.4 2 0 )

Include ( "..\\Common_Model_stds\\US\\USRA_SS_Boxcar_Tim_Mui r_Model\\XM_USRA_SS_MTY_Weight.inc" )
Include ( "..\\Common_Fleet_Stds\\US\\Single_Pipe_AB_Brakes. inc" )

Sound ( "genfreightwag2.sms" )
Name ( "XM 40' MILW <USRA SS> 702584 MT" )
)

[muskokaandtahoe]

The paths tell you whether or not the include file is something fairly standard to a specific country... something that will be used by most of your fleet. I do have some variants, such as type D, E, and H couplers, types KC and AB brakes.

The common model path indicates the model has been skinned for many different railroads. We wind up using multiple directories because of that yet when you get down to the parameter values they're all the same w/o regard to how they were skinned. Rather then put the include files in one railroads folder I created the common_model_stds folder, added a country code to keep things organized, and then put all the common include files for that car design in a folder I identify by who created it plus something about the real object... the locomotive type for instance, or the car design.

That way the include files won't up and disappear if I happen to get rid of this or that car folder and I beleive it will be a cleaner way to distribute include files too.

[muskokaandtahoe]

Now to answer your specific question, what the OR manual is saying is you don not have to create a special folder in each .wag or .eng folder to store your include files because the syntax of the statement allows a path.

So you could stick them anywhere.

What I've decided to do is set up two areas, roughly patterned after trainset\common.cab and \trainset\common.snd, that I've placed in the \trainset folder.

The first is \trainset\common_fleet_stds and the second is \trainset\common_model_stds. Both have a set of subdirectories that are simply short codes to designate the country. I'm primarily interested in US Railroads so I've got US for that but I've also added France, Germany, Japan, and UK. I've done this only to keep things organized.

Within the country code folders things are a bit different between fleet and model stds. For now the common_fleet_stds hold just .inc files. I've been thinking about dividing those up between freight, passenger, and locomotive but I've not done that yet.

Over in the common_model_stds I learned early on that I needed many folders that were specific to whatever physical object the guy who made the mesh had in mind without regard to skinning, meaning if he was doing an Alco S-2 locomotive and he skinned it for a dozen different railroads, 4 numbers each, I wanted one folder -- an Alco S2 made by Joe folder -- where I'd put all of the include files that would be common to many railroads instead of copying the include files to a dozen folders, one for each railroad. Here too I'm considering inserting freight, passenger, and locomotive to improve organization

Last, if it is clear the include file is relevant to only one folder and there are multiple .wags or .engs that will use it (thereby justifying to work to create it), I'll put it with those files.

IOW the final location depends entirely on how many folders inside of \trainset can use each .inc file. If it is most folders then the .inc files probably belong in the common_fleet_stds. If it is several, then perhaps it goes in common_model_stds. If one, then just that one.

Ina few cases I have uncompressed .s files and renamed some of the skins -- those that have the initial and number on them -- and renamed .ace and .wag files as well, all for the purpose of consolidating multiple folders. So instead of having three or four folders for some of Tim Muir's GS gondolas I now have one folder that takes care of the owner and class: "GS_SP_G-50-12". I've done that for almost all of Tim's freight cars as well as a number of locomotives. The folder name tells me exactly what is to be found within and the individual .wag files tell me something about how each has been skinned.

[muskokaandtahoe]

Finally (yes, there might actually be an end here ) if you want to see the contents of any of my .inc files listed above, ask by name and I'll post it.

[R. Steele]

Wow, thanks Dave, a wealth of information. I had not got it into my head that the include could also use a path - much like an alias for sound and cab folders. Once I saw how you set it up, the fog began to clear. Thanks.

I'm going to bookmark this thread in case I ran across anyone else who needs some clarity on the OR include command.