This post describes the issues and proposed folders. Post #2 is a procedure to follow when assigning files to a location. Posts #3-6 are examples
IMO KUJU's solution for cab files is a good template for locating include files. After much experimentation I'm proposing am solution that addresses these needs:
- A folder for widely used .inc files, much like what is in \common.cab.
- Recognition that many end-users have routes and equipment from many countries and therefore it might be useful to group certain files for each country.
- Acceptance that many payware vendors sell the same mesh skinned for many railroads and when distributed there is a unique folder for each railroad.
- Addressing the easiest to solve problem of minimal commonality, where everything belongs in one folder.
Proposal:
Within the \trains directory,
- Add \common.fleet
- Add \common.model
Within both of those directories, add folders (one for your own country and others only as needed) for country codes. Examples:
\AUS Australia
\AUT Austria
\BRA Brazil
\CAN Canada
\CHE Switzerland
\CHN China
\CZE Czechia
\DEU Germany
\FRA France
\GBR United Kingdom
\HRV Croatia
\HUN Hungary
\IND India
\ITA Italy
\JPN Japan
\NLD Netherlands
\POL Poland
\RUS Russian Federation
\SVK Slovakia
\SVN Slovenia
\SWE Sweden
\UKR Ukraine
\USA United States of America
\ZAF South Africa
For myself, this means I will have (at least) this:
- \common.fleet\USA
- \common.model\USA
Because there are many instances of multiple people creating models for the same locomotive or car there are cases where the parametric values will differ from one person's model to another -- different sizes, different location of lights, etc. To protect end users from inadvertently over-writing existing .inc files from person A when installing a similar model from person B I decided it was probably best to add a directory layer in the \common.model tree that is based on the model and maker names (e.g., \F7 by 3dtrains).
An example:
- \common.model\USA\F7 by 3dtrains
Last, the .inc file itself should be named for what the parameters contained therein describe (e.g., \Std_Steam_Locomotive_Bar_&_Coupler.inc ).
Examples:
- \common.fleet\USA\Std_Steam_Locomotive_Bar_&_Coupler.inc
\common.model\USA\F7 by 3dtrains\F7A_Engine_Specs.inc
======================
Possible issues
Is there a need to add an additional folder layer for \freight, \passenger, and \locomotive? I'm inclined to say no, but am open to being persuaded otherwise.
Is there a problem in the directory trees WRT files being used by multiple countries? I don't know. The US and Canada had a lot in common.