Plugin Folders - Explained

[Cougar2004 127]

Plugin Folders - Explained

Downloads of new Vehicles, Props, Textures, Lots, etc... are usually placed inside subdirectories of the MyDocs/Plugins directory.  This allows for useful organization of thousands of files for the heavy downloaders. However, there are a few other aspects to the Plugins Folder that I would like to have clarified.  So here are the remaining questions on the topic.  (This information does not appear to be in the Omnibus.)

1.  Load Order - Which MyDocs / Plugins Subdirectories are read First?  Does it go alphabetically? And how does this help us - is there some useful theory that we can apply based on the order downloads are loaded?

2. Main ONLY - Why (When) are some downloads Required in the Main MyDocs Plugins Folder?  Some such as 'Swamper77 Automata Essentials File' and 'Extra Cheats Plugin' MUST be put in the main directory and not subdirectory.  What could happen if put in subfolders?

3.  HTML & JPG - Should HTML, TXT readme files, and image files be in the Plugins Folders at all?  It seems that the game may try to load these unusable files and either successfully waste memory, or at least slow up Game loading time.  What is the best practice (smart) and why, regarding these related but non-dat, non-lot files?

4. Difference - Why are there two different Plugin Directories, Program Files and MyDocs?  Which types of files should be put into each, and when?  What makes the most sense?  And why do some files require being placed in one or the other?

5.  Doubles - What is the concern with having double files?  I understand the Cleanitol system has been created by some very inspired SC4 Game enthusiasts to help solve the problem of adding components twice to the game.  How does it work?  What are the risks of 'uncleaned' plugins folders?

6.  File Types - What are the all types of files that 'function' in the Plugins Folders?  What does each file type have the potential to provide to the game?  Are there any dangerous or bad file types that should not be placed in the directories?

7.  Size Limit - What is the maximum size the Plugins folder(s) can effectively be?  Is there a suggested limit for best performance, such as 100MB or 500MB?  Is there are a play performance or load time degredation related to increased Plugins Folder size?

8.  Other Thoughts - What else do you know about the Plugins Directories which you have found useful, but is not addressed already above?  Advice?  Suggestions? Concensus you have read from another forum thread on the topic?

Thank you for reading the topics, and to those who offer answers. 

[Vahr 341]

1. First the root directory (in ABC order), then the subfolders (in ABC order of folder and of anything inside)

2. Extracheats.dll is called from the root plugin directory and is hardcoded. (DLL's are application extensions and must be in a prescribed directory)

3. I generally remove those.

4. Programs folder loads before MyDocs. See 1. for load order.

5. Sometimes multiple instances of an item can cause conflicts which result in crashes. Some mods (like the NAM) are dependant on special files. If you have another instance of the NAM in a different place, you can get issues with those files.

6. Any file type that contains DBPF data (thats what all the SC4 formats are written in) so .dat, .sc4model, .sc4desc, .sc4lot.

7. Depends on computer.

[SC4BOY 20]

Blue Lightening has done a fine job.. I'd only expand a bit

1. It isn't really "ABC" order.. its actually DOS (old time stuff   and isn't totally intuitive. If you follow the following procedure you will get a list of the files processed in EXACTLY the order in which it will be done. Of course it won't list those in the maxis directory.. you can repeat it there, but normally there are very few files there.

Open the DOS Command Line (or Command Prompt), found under Accessories.
Change the directory to your plugins folder (with the CD command).
Enter the following command:

DIR *.* /B /S >LIST.TXT

That will create a LIST.TXT file, listing all your files in that folder and all its subfolders

Recall that SC4 (and DatPacker) "smushes" these all together and any files that are repeats (even if they contain the INTERNAL stuff alike, gets overlaid on each other while building another file.. that file will contain only the LAST version of the data read, so that is why order is important. And you can use your own judgement whether dups are an issue.. it only matters in processing time, as there will be only one copy (the last in DOS order)  in the "SC4 operating" file

2. .. yep.. I'm not a mod'er so I don't understand really why, but if the instructions tell you, then do as they ask.. Usually these contain "essentials" stuff (ie User Interface" stuff and "action" or "animation" items) and global "reporting" type mods.. Perhaps someone else can give you a better answer here.

3. Since I use DatPacker I don't care (nor does SC4)  The games knows the kind of files it is looking for and any file that is not that type will be ultimately skipped... However the system does have to check through these, so if you have a CLEAN plugins folder it will accellerate the startup process a bit. They should cause no harm.

4. The programs or maxis folder generally contains "permanent" stuff.. patches and maxis items, etc and as mentioned is processed first. Most "special content" (due tto the "paste over the last" method) function by "replacing" or adding content to the original games content.. that's why those "user additions" are put in the "My Doc's" location. Also if you have more than one user on a windows system, the custom "My Docs" will be in each person's folder and thus they can play the game on it and it will still be "customized" to each user. The maxis folder too is often used for "global" changes such as terrain and water mods.. but this is preference.

Keeping the above statements on order in mind, they are interchangeable.

5. It doesn't matter.. if you have a problem with a special it likely will cause the problem anyways whether its a dup or not. (this is not the same issue as specials having conflicts which cause crashes). It takes system time in processing, but normally isn't an issue unless you are a real slob with your folder "housekeeping"

6. agreed

7. It does indeed depend on your hardware/software combo.. Some people get problems at only 100M, but others can operate happily with 5Gb.. If you keep adding stuff and you keep growing your city, sooner or later ANY SYSTEM WILL DROP TO ITS KNEES!!! 
 

[CaptCity 4,772]

A few other thoughts...

Originally posted by: Cougar2004

Plugin Folders - Explained

1.  Load Order - Which MyDocs / Plugins Subdirectories are read First?  Does it go alphabetically? And how does this help us - is there some useful theory that we can apply based on the order downloads are loaded?

2. Main ONLY - Why (When) are some downloads Required in the Main MyDocs Plugins Folder? Some such as 'Swamper77 Automata Essentials File' and 'Extra Cheats Plugin' MUST be put in the main directory and not subdirectory.  What could happen if put in subfolders?

As Blue Lightning mentioned, files in a 'root' folder are read in alphabetical order first followed by any folders that are present. This is sometimes important for load order when certain game aspects need to be 'pre-set' or 'over-ridden' for other iems to function correctly. This is why you might see file or folder names beginning with an 'a' or a 'z'.

3. HTML & JPG - Should HTML, TXT readme files, and image files be in the Plugins Folders at all? It seems that the game may try to load these unusable files and either successfully waste memory, or at least slow up Game loading time.  What is the best practice (smart) and why, regarding these related but non-dat, non-lot files?

Exactly... The game will load and check any file in the Plugins, including HTML, TXT, etc..., disreguarding anything not needed for game function. Therefore, a rather large number of non-functional files could slow-up loading time noticeably as the game 'determines' their functionallity.

5.  Doubles - What is the concern with having double files? I understand the Cleanitol system has been created by some very inspired SC4 Game enthusiasts to help solve the problem of adding components twice to the game.  How does it work? What are the risks of 'uncleaned' plugins folders?

As mentioned, conflicts could and will occur with certain files if older files are present with newly loaded material. Exact duplicates may not cause crashes or function problems, but may cause an increase in load time if prelevant..

Just a few more cents...

[tungston 19]

Data is loaded alphabetically, to explain this:

When files are copied to the hard drive, they start at the first open space.  If that space doesn't have room for the complete file, the rest is copied in the next open space.  That is what causes fragmentation, the reason you need to "defrag" the hard drive occasionally.

When you look at a file manager, i.e. Windows Explorer, it appears that all files are keep in a neat little area.  When in fact the files are scattered "nilly-willy" all over the hard drive.

Anyway, on with the main point.  Because of the way files are copied to the hard drive, there is a need for a "table of contents", or "directory".  The directory "tree" as any index is, arranged in alphabetical order.  The "root" branch [C:\] contains all of the subbranches.  [One of the previous version of Windows started calling the branches "folders".]   The directory only has a list of the hard drive address[es] of the file.  Windows uses that list order to load the file data.

If you have the Windows Explorer set to list by name, then what you see is how they load.

The Simcity 4.exe gives the OS directions as to the order to load the plugins folders.

[SC4BOY 20]

There is a difference between "dup's" and identically named files.. Dup's are just that .. they are EXACTLY ALIKE just in different locations

oh, almost forgot.. SC4 doesn't care what the title is or if it has the same name as another.. it only processes the codified data INSIDE the file..