Tutorial on the use and organization of the Plugins folders

[IThink2 1]

Thank you for this tutorial. It was very helpful to me. I do have two questions. You mention that:

----------------

The secondary Plugins folder is in the following path:

C:MyDocumentsMaxisSimCity4Plugins

 

<<SNIP>>

 

So, it is under this folder (directory) that I like to create a set of sub directories to keep things organized. Now keep in mind that anything you move OUT of the plugins folder into one of these sub folders is no longer available to the Plugins Manager.

Files stored in a sub folder can still be loaded by the LE, but will not be changed by the LE when you are editing a lot.

 

----------------

Could you confirm for me that you are telling me that I can still place DAT

[GrampaAl 76]

Whoa, a long winded question(s).

 

Basically everything is true EXCEPT you can not window switch.

 

To change the contents of any plugin or subfolder, you WILL NEED TO EXIT THE GAME.

 

The reason for this is that the game needs to load into memory all the data before it starts. Once running, it won't load any more than is already loaded.

 

As for the little town of Ruth, I can certainly understand their feelings. I won't move back either.

 

That town is in the foothills. I am in the mountains further west.

[pookakitten 0]

GrampaAl,

I've a suggestion to streamline creating the directories. If you use WinRar ( http://www.rarlabs.com ), when you are working in Windows Explorer, you can right click to get a list of choices. Simply use Extract to (ZIP file name) or if there is more than one ZIP file highlighted, the option becomes Extract each archive to separate folder. Each file creates a new directory based on the name of the ZIP file. Then transfer the directories to the SC4 plugins directory, and you're done!

Samantha

[GrampaAl 76]

Sorry Samantha, but that is a BAD idea.

 

Some of the lot makers included readme.txt files, as well as .jpg pictures of their lots or some instructions to use with their lots.

 

These files YOU DO NOT WANT to be in ANY of the plugin folders.

 

So extracting to a sub-folder should NOT be done.

 

Only the .SC4lot file or .dat file and now including the .desc and .model files from the BAT should be in your plugin path. All other files should not be in this path as there are known problems when doing this.

[pookakitten 0]

Actually, I thought pruning the directories was assumed. Silly me.

I also greatly dislike making directories in Windows. What a pain compared to the glory days of command line DOS. Why switch between clicking and typing, when all you needed to do was type mkdir CSX? I guess I'm showing my computer use age now.

Samantha

[Vlakhaas 13]

Some Admin should really PIN this .... it is currently on page 10 or so ...

[BarbyW 40]

I second that, Vlakhaas. Please will an Admin pin this.

Barby

[Equinox 1,218]

Hmm ... I would post a screenshot of my folder, but I'm right in the middle of reorganizing and revamping it before I start a new region!  (I'm a neat freak ... )

[Briman 5]

This is what I do..it is really simple and works well

 

 When I dl a lot or a bat I use the open command instead of the save. Because im using XP I can hit the extract all which gives ya a window where you can browse which folder (plugin) you wanna put your lot.... But you can also while there create a new folder ,name it and extract your lot or bat directly to the new folder in your Doc/SC4/ Plugin Dir... works well and not much work at all...

 

I also have a folder which I named Plugin Extras. Here I place files that im not currently using. It can be in your Doc/ SC4/ folder and will show up near the Plugin folder for quick changes. This is perfect for the train set mods I might add for those of you who prefer not to use all of them at the same time. Keep it simple and you cant go wrong. And yes for the lots I dl I use subfolders usually named after the creator or the type of lot.

I used to just put the lots in the Plugin folder and that was a mess. But if you are able to read file names its not hard to organize if you didnt use subfolders.

[GrampaAl 76]

Time for a little update folks.

Some have asked where they should place their BAT files.

I recommend first that you have a subfolder in the Main plugins directory named Props, and now I also recommend another subfolder in the Main plugins directory named BATs.

All props (and many are BAT props) and yes even other BAT files will work best in the Main plugins folder.

Leave the My Docs plugins folder for your .sc4lot files, and the files you are currently working on.

If you don't do modding, then all lot files should be in the My Docs plugins path, and ALL OTHERS should be in the Main (Program Files) path.

You will get some previously hidden benefits if you do this.

Look very carefully at some of the newer CSX lots and now especially at the BLS GA series, with the hover query, and you will see new items not previously revealed with the hover query.

[shawn2166 0]

so bat files go into the program file folder and lot files goes into my documents?
and only extrac then lot and bat files and not with pics or readme files? is that right?

[GrampaAl 76]

Date: 5/7/2004 11:52:27 PM
Author:
so bat files go into the program file folder and lot files goes into my documents?
and only extrac then lot and bat files and not with pics or readme files? is that right?

quote>

Yep!

Never place picture files (.jpg), text files (.txt) or the downloaded file itself (.zip) into any plugin folder.

[Serotonin 0]

Thanks for the tip on the two seperate plugins folders. I didn't notice that part when adding some things I found on this site. Just from a downloader standpoint, I'll use that to seperate the Maxis plugin items from the great things I find here

Also, I wanted to take a quick minute and advertise a great program for Windows users to organize files: Total Commander

[senekerk 0]

Let me see if I understand I know sc4lots go into my doc plug in, allother into maxis plugin. I am making a folder for EACH of my sc4 lots I've downloaded -no images or readme files. Iwas going to place those into my plug-in folders, but I think I hear you saying they should be put in subfolders of my choosing--Then put only the ones in I want is that particualr game. Or do all the subfolders go into the plug-in file?
I am not using lot editor oranything just using bat and lots in the game.

Or forgot to ask what is the proper way to label lots, BAT etc. with the name or the id code.

I apologize if I am not suppose to ask question on soimething that is pinned????

[GrampaAl 76]

How clear can I make this.

I tried to give the REASONS that you put items into various places.

The names of the subfolders is not important just that you know what you put in them.

If you wish to move subfolders in and out for certain cities, well you may, but I don't recommend that. Too much maintenance, and too much to remember.

I recommend that ALL of your downloads go into one of the plugins folders (or subfolders).

Props, and BATs should go in the Main plugins, and lots should to into the My Docs plugins folder.

Once you understand WHY then you can organize your own folders which every way you want.

I was trying to explain WHY, and what happens when you organize them in a particular way.

The CSX lots and now the BLS GA lots that I have been involved have some neat little easter eggs that will only work correctly if you have the files in the correct place.

No harm is done if you don't but you just don't get those little eye candy items.

[buckbeach 8]

When you advise that the BAT file goes into the Program's plugin does that include the included SC4lot in the BAT file.

PS other BATters advise the entire file go into a subfolder in the Document Plugin.

I'm confused.

[GrampaAl 76]

Hey dood! I have pasted a couple line from the post above.
In fact I am pasting them three times so you can read it and re-read it again and then read it one last time.

If you are still confused, then I can't help you further.
---------------------------------------------------------
Props, and BATs should go in the Main plugins, and lots should to into the My Docs plugins folder.

Once you understand WHY then you can organize your own folders which ever way you want.

I was trying to explain WHY, and what happens when you organize them in a particular way.
---------------------------------------------------------
Props, and BATs should go in the Main plugins, and lots should to into the My Docs plugins folder.

Once you understand WHY then you can organize your own folders which ever way you want.

I was trying to explain WHY, and what happens when you organize them in a particular way.
----------------------------------------------------------
Props, and BATs should go in the Main plugins, and lots should to into the My Docs plugins folder.

Once you understand WHY then you can organize your own folders which ever way you want.

I was trying to explain WHY, and what happens when you organize them in a particular way.
----------------------------------------------------------

I am unable to explain it further.

Do you know the difference between a lot, a Prop and a BAT?

A Lot file has the extension .sc4lot
A Prop will have the extension .dat or .sc4desc.
A BAT will have the extension .sc4model.

Now generally both the .sc4model and the .sc4desc files are what are used to define the BAT file.

Again! ALL .dat, .sc4desc, and .sc4model files will work best if placed in the Program Files Plugins path.

Again! ALL .sc4lot files SHOULD be placed in the MyDocs plugins path.

NO OTHER FILES SHOULD EVER APPEAR IN EITHER PATH.
NO .TXT FILES, NO .ZIP FILES, NO .JPG FILES AND SO ON.

In the event you place all of these files in the MyDocs plugins you may not notice the difference, but the more meticulous players and the better more experienced players WILL notice the difference. It is subtle but entertaining. You get more easter eggs if arranged they was I have outlined.

[jasperdeman.nl 1]

Hy, I think your tutorial is great, but i have to make a sidenote:

in your -Program Files- plugin folder are a few .PNG picture files you must not delete, these files are for the background in the game

Voor de Rest a Good Tutorial, wich helped me alot!

[GaryGerbrandt 6]

Should (or could) you rename lot files? (i.e. Newman_Inc_Castle_0d730c8f.SC4Lot to NewmanIncCastle.SC4Lot?)

[GrampaAl 76]

Date: 5/15/2004 10:02:31 AM
Author: jasperdeman.nl
Hy, I think your tutorial is great, but i have to make a sidenote:

in your -Program Files- plugin folder are a few .PNG picture files you must not delete, these files are for the background in the game

Voor de Rest a Good Tutorial, wich helped me alot!

quote>

Absolutely, this is true. Do NOT delete the 5 PNG files which were there from installation. Indeed these are the background file for the regions and lots. Some folks may have modified these, but it is necessary to have some kind of background files here. Don't move then either.

Good point, well made. Thanks

[Cobb32118 244]

Date:5/8/2004 11:41:02 AM
Author:GrampaAl

Date: 5/7/2004 11:52:27 PM
Author:
so bat files go into the program file folder and lot files goes into my documents?
and only extrac then lot and bat files and not with pics or readme files? is that right?

quote>

Yep!

Never place picture files (.jpg), text files (.txt) or the downloaded file itself (.zip) into any plugin folder.

quote>

GrampaAI, a while ago, either you or Vlakhaas I'm pretty sure, had recommended that lot-makers include a jpg file so that users could easily identify what the lot actually is.  (Sorry if that wasn't you or Vlakhaas -- I might be remembering it wrong)  Anyway, if you do recomend having the jpg there at all, then in my opinion it wouldn't do the users any good if it is not there with the other files.  This is why I have been recommending that users extract all the files into the plugin directory.  So even if someone didn't organize the files into folders, all of mine would fall next to one another for easy identification.

So my question is:  Could you tell us what the actual problems are with having the readme files and jpg files in the plugin folder?  All the anecdotal evidence I've gotten from my own testing, and from most of the people using my lots, is that the game ignores these files in the plugin folder.  But I will change my directions if you think this can cause a problem for the users!  Thanks for all your hard work on your tutorials! 

--COBB

[GrampaAl 76]

Way, way, way back when, I was told by the then experts that having .txt files, .zip files, or .jpg files COULD cause the game to crash.

I am not sure if this is true or not. It has NOT happened to me, but then I don't place those files in my plugins directories anyway.

Why don't we try to use some logic here.

Since the program does not need these files, WHY THEN should we place them in the already crowded directories that are supposed to be for game PLUGINS?

Those related files which serve the purpose of aiding the user to identify, assist or help the user (especially the NEW user) to know just WHAT TO DO with the files that we include in the .zip file are more like help files and not used by the game.

However, these guidelines that I have provided are my RECOMMENDATIONS, not the law.

If you wish to place those files that are not needed or used by the game into your sub-folders or into your plugin directories, then by all means be my guest.

If someone has problems later, then just remove them.

It could have to do with the settings in your registry, who knows. It could also have to do with what operating system you are using. I don't know about those, I just know that those files are NOT NECESSARY, so why place them in the Plugins directories anyway.

Now the more experience player, one who makes mods, or makes lots or makes BATs, and wishes to organize their folders differently for their own purposes, go ahead.

My tutorial is aimed at the new user or the user who does not make lots or BATs or mods.

If those players follow these guidelines, they will at least reduce the risk of problems, and also have the benefit of the game loading files in the correct order to see whatever small benefits we lots makers may place into files that have dependencies.

Keep in mind that if your lot file has NO dependencies, then it makes no difference at all.

However, at least for all of the CSX lots, and the BLS lots, we use dependencies extensively, part of giving credit to the original creators of props, BATS, and mods, and in those cases it DOES matter what the loading order is.

You always want your LOT, which contains props or BAT files to load LAST, so anything special contained in the lot over rides the originals if necessary to display the special characteristics that we as lot makes have ADDED to the original creation.

Many props created by BAT artists, are visual only, and do not have descriptions included with them that can be seen in the game. Try the hover query on all of the normal in game props and for the most part all have some sort of a description displayed.

Now try this for most custom props, and you see nothing.
Well, we have the capability of adding this to the original BAT props or buildings so we still use the original model file created by the BAT, but now have a new exemplar which contains a description for use by the hover query, and it is necessary for this to work, to load after the original so you can get the new benefits of the description for the hover query that was not there at the time of upload of the original.

Remember, those who make BATs are for the most part artists with a talent that some of us just don't have. However, they are not modders or lot designers also.

So it is up to us modders and lot designers to add or enhance those things we can to make the game more interesting and fun.

So you see the Artists, Desginers, Creators, and Modders working together make a better final product that any one individual generally can by themselves.

There are a very few people with the multiple talents it takes to do it all.

Is precisely this that makes THIS site so much better than the other sites.

So enjoy what is offered here, and hey if you can, contribute some money to Dirk to keep this site running so well.

[Cobb32118 244]

Date:5/16/2004 2:25:05 PM
Author:GrampaAl

[...]

Why don't we try to use some logic here.

Since the program does not need these files, WHY THEN should we place them in the already crowded directories that are supposed to be for game PLUGINS?
[...]


It could have to do with the settings in your registry, who knows. It could also have to do with what operating system you are using. I don't know about those, I just know that those files are NOT NECESSARY, so why place them in the Plugins directories anyway.
[...]

quote>

GrampaAI, thanks for answering in such detail!  You certainly put a lot of work into this.  It's much appreciated!

Let me just answer the part about why include the jpg (which was originally someone else's suggestion anyway.)

You can see here, the way I name my files, the user can either dump these into their plugin folder as-is, or into a Cobb folder if they wanted to, and the lots/buildings stay ordered together.  And with the jpg file there with the lot, the user can browse the directory and quickly see what the lot actually is.  Of course as the one who made the building, I can't imagine not knowing what the Cobb Royale is.  But I'm sure the typical STEX shopper wouldn't necessarily remember that.

So in short, I absolutely agree with everything you said in your answer there.  This is just to answer why include those files.  I'm just glad you pointed out that there is a potential problem -- so if I continue to provide the jpg and readme like this, maybe I'll but a disclaimer that the user can/should delete the jpg and txt files if they suspect it may cause a problem.

Thanks again for all your help and hard work!  --COBB

[SimGoober 2,364]

Cobb, I believe I was the one who origonally resommended including a Jpeg with the files.  I did so for the basic reason that you describe ; easy identification.  I can't tell you how many times I've tried to figure out what lot goes with what files; some people put weird names on them.  I'm now a stickler about using sub folders for each lot, and my sub folders have subfolders a lot, to keep different types grouped together.

 

Also, just to be clear, is it ok to change any or all files names?  If I am not mistaken, the file names are almost unimportant, just what's inside them is used by the game.  Is that correct?

 

I have been tossing GrampaAls idea of keeping only lot files in the my docs area, but I know I'll get confused if I split things up. For the most part, I keep all the files from the zip, but not the zip, in the same folder.  There are exceptions, but these are fairly obvious ; mods, prop packs, textures, etc.  I am now also working on a set of generic custom queries and sounds for my lots, which will all be kept in one dat files for easy updating.  That file is still in the my docs, but in the root plugins folder.

 

For the record, I have no problems with the game keeping these files in this manor.  I would not be at all surprised that GrampaAls suggestion would enhance game play a little, but just my personal opinion, my system works for me, and I probably won't change it.

 

Thanks to GrampaAl for his commitment to keeping us all up to date!

[Cobb32118 244]

Date:5/16/2004 9:46:39 PM
Author:SimGoober

Also, just to be clear, is it ok to change any or all files names?  If I am not mistaken, the file names are almost unimportant, just what's inside them is used by the game.  Is that correct?

 

quote>

Simgoober, what I noticed is that if you change the name of the model file, and then go into properties for the lot or the desc file (perhaps both -- can't remember now) and look under the plugins tab, you get this little red error X icon next to the field where the model file goes.  So when I'm making my own lots, I always change the model file name BEFORE  I create any of the other files.

HOWEVER, even when I have had the error icon, the lot still seems to work in the game.  So, it's reporting it to be a problem, but doesn't seem to act like it is in reality. 

But I'm not sure it's a coincidence that the most common problem I see with lots from the exchange is the building not showing up.

[cow 1]

Date: 5/8/2004 6:05:15 PM
Author: GrampaAl
I recommend that ALL of your downloads go into one of the plugins folders (or subfolders).

Props, and BATs should go in the Main plugins, and lots should to into the My Docs plugins folder.

Once you understand WHY then you can organize your own folders which every way you want.

I was trying to explain WHY, and what happens when you organize them in a particular way.

The CSX lots and now the BLS GA lots that I have been involved have some neat little easter eggs that will only work correctly if you have the files in the correct place.

No harm is done if you don't but you just don't get those little eye candy items.

quote>

I have searched high and low for any information regarding these easter eggs on the csx lots and have found no references or information regarding them except here in this one thread. can you please tell me one specific lot that has these easter eggs so i can experiment with it and see the difference it makes by placing it in what you consider the correct place versus the wrong place.

[BarbyW 40]

Try the latest BLS GA farm - de Groot Limes.

Barby

[GrampaAl 76]

Just in case you folks are looking for little colorful oval shaped things, this is not what you find (well maybe on Easter).

Easter eggs in computereze is anything that you might see or come across that is extra or unexpected.

Now whether you expect to see all things or not depends a lot on your idea of what you expect.

With most custom lots that use custom props, you will not generally see anything when you hover the normal query over the item.

Some lots won't even show their own name with the hover query when hovered what you expect should be the main building. Ours should show this at least. But hey, try hovering over other little props. You may see a neat little name for the item or you may not. Organization will only help. The item also have to have a name in order to see it. If both are present, then voila!

Have you looked at the store fronts of large buildings in the normal game? Yes? Now try this for the large BAT buildings. What do you see? Nothing? Just as I thought.

Ours will generally show you something. You never know what, it depends on my mood when I do this. Heck I might even swear at you. Well actually that is not may nature, so I won't. BUT I COULD!

[pekeboo01 3]

GrampaAl,
Yesterday I downloaded a file from the Stex and with it was the ususal lot, model and desc. files. Also included were 2 prop files. May have been the deGroot lime farm. I put the lot,model and desc. in my main plug in folders and the prop files in a sub folder in the main directory. Is this the correct way? Or should I remove the lot file and put in in my docs. plug in folder? Thanks for your help.

[GrampaAl 76]

I suggest you re-read the posts above.