Modding Made Easy: A Beginner's Guide

[docj101 99]

 

There are many threads across several sites that discuss this same information.  However I've looked around and I can't find a good beginners guide for modding that still has active links to pictures or much depth.  So I have created this to help fill the void in 2013.  I'm sure that people are still (re)discovering the game all the time.  This is my small attempt to help them/you get started customizing their cities and experience.

 

Modding Made Easy by -Docj

 

The process for creating 'certain' game modifying plugins is actually very simple.  The steps I am going to illustrate in this guide can be applied to anything contained in the simcity_1.dat.  From bus stops to the traffic simulator, after reading this you will be able to customize many things in the game to your liking.  You can also use the process to adjust the values of downloaded plugins more to your liking.

 

The only tool(s) required for this is "iLives Reader" v1.4.  Getting this program installed and working properly is covered here, and here, among other places.  You can also use "iLives Reader" 0.9.3 to do the exact same thing however you have to do manual 'hexadecimal' to 'decimal' conversion for everything (hex - decimal converter).

It is always safe and very functional to open and view file properties in v1.4, the automatic unit conversion can save time.  Sometimes v0.9.3 is preferred for editing because of potential file corruption upon saving with v1.4.  I run both readers; trying v1.4 first, then after checking for problems revert to using v0.9.3. 

 

Assuming you have "iLives Reader" installed and configured, then you can continue with this guide.*1

 

The goal of this example:

In my example below I am going to modify a city hospital so that 1 actually serves the same function as having 2 side-by-side.  I am going to double some values so that it serves and employs more sims.  Accordingly I'll raise power/water consumption, costs to plop, as well as increase the pollution this hospital creates. 

 

Without some extreme measures being taken I can't successfully increase monthly operating costs of the hospital.  I have found altering those values creates a bug causing all hospitals to reset themselves to MAX funding each new month.  I bring this up as a good example of things that can go wrong, and the sort of thing to watch for.*3  I will be modifying 7 properties to achieve my desired effect.  I chose to make a basic mod with multiple changes to illustrate a few points that would've be hard to explain by making a simple, single value change.

 

Please keep in mind, this is an example, and may not be practical for your personal use.  The results of this hospital mod will cause ALL of your region's hospitals to adopt it's effects, but only if the .dat is in your plugins folder.  These hospitals can still be funded with sliders according to demand in game.  100% funded is now 6000 patient capacity + 200 doctors, likewise, 25% funded is now 1500 patient capacity + 50 doctors.  Cost per patient in this hospital mod will be cut in half, this is the only attribute where original game balance is somewhat lost.

 

 

The process for creating a basic game modifying .dat file.

 

1. Launch "iLives Reader", open simcity_1.dat,

2. Bring up the 'navigator' view window.

3. Within the left side directory tree: navigate to "Civic Buildings" > "Buildings" > "CV44x44_LargeMedicalCenter_0313"

4. Within the right side properties window:  recognize those highlighted are the 7 properties I will be adjusting for the hospital.  Double-clicking any property opens it for editing.  From here I am going to begin with 'demand created'.

5. (This only applies to "Reader v1.4")  After opening a property to edit you'll see the editor.  In the editor window change the values from 'default' to "Display as" 'Int' (integer).  Now you see the property's value in a form that is easily altered.  In this example below, the associated property ID is also shown, and this will not be changed. *2

6. In the appropriate field of the editor window you can change the 'value' to any number you want. In this example I am using 'demand created' and multiplying jobs x2.  For a building where you find 'demand created' for jobs and amenities together: the values should be increased together equally.  What this is doing is creating the extra jobs and ensuring residential demand for the appropriate sims needed to work there.  These 3 numbers are the distribution between $, $$, and $$$.  Notice most workers are $$.

7. Click "set" then "apply". The property window will close at this point and the changes are temporarily saved.

8. Now, I am going to move right down the list, adjusting the remaining 6 properties one at a time.  To keep the balance of the original hospital I am going to double the values.  Most properties are straightforward and easy to recognize and modify.  However, 'Sint64' 'data type' doesn't convert 'int' correctly for me.  If I type 2200 for "plop cost" and hit 'set', the number turns into 8704.  I had to enter the number in as 'hexadecimal' aka 'base 16' instead of 'decimal' aka 'base 10'.  If I convert 2200 from decimal to hexadecimal I find that 898 entered as 'int' will give my desired 2200 cost to plop in game; double maxis default. *2

9. These last 2 properties are best thought of as a pair that you should increase together equally.  The term "catalog capacity" is refering to the number the game uses to properly display the capacity in the menus.  The corresponding "hospital patient capacity" is refering to the number the game actually uses and shows you upon building query.  Keeping these values the same ensures 'displayed capacity' and 'actual capacity' are the same everywhere.  I will change these values to 6000 now.

10. Now that all 7 values have been adjusted I want to make a small .dat file that will override the default values in the game by being in the plugins folder.  I don't want to just try and 'save' these changes directly to "simcity_1.dat"; that would be permanent and it doesn't work that way.  So on the left side directory tree 'right-click' "CV44x44_LargeMedicalCenter_0313", then click "add to patch", then open the "patch manager" by clicking on it's button up top in the 'tools' panel.

11. In this window you will see "CV44x44_LargeMedicalCenter_0313" as the only entry. Highligh it, Click "Create DAT".  A dialog asking for a filename and

location will appear.  You can name it anything you want as to easily identify it (i.e. My_Hospital_Mod).

12. Navigate to where you saved the .dat file and drag or copy it into your '....username\Documents\SimCity 4\Plugins' folder.

13. Next time you enter the game you will see your new capacity at all maxis hospitals, without rebuilding.

That's it, that's all there is to it!  This mod works applied directly to my game with no problems.  "IF" you encounter problems with the 'budget slider' after editing civic buildings, you may need to bulldoze all existing civics of that type before using the mod you created.  Bulldozing all civics of a type first also allows for 'budget cost' adjustments to work.

 

I realize I made this explanation rather long.  I wanted it to be easily understood by even the most novice of modder.  Using the steps I provided you can start using your imagination.  For example:  maybe you decide your Sims found a way to make burning coal cleaner, cheaper, and more efficient.  Now implementing such a change yourself is possible.  You can lower pollution amount and radius, lower the plop and operating costs, and increase power capacity... maybe name it "Infamous_Clean_Coal_ Tech".  You can now open anything you want to look at and adjust it's values.  Start making some .dat files for yourself! 

 

A few tips:

• You can copy and paste properties and values to speed things up.
• You can open multiple .dat files side by side for comparison or to find properties you may want to copy.
• You can add multiple adjusted files to a .dat by repeating steps 1 - 10 clicking "add to patch" each time. 
• After you have added multiple files go to step 11 and you can create a .dat that combines those changes into one mod file. 
• You can open any other previously created .dat or lot files to edit and save, or create a .dat of your own from them.
• Try to avoid creating conflicts by having 2 mods of the same type installed simultaneously. 
• Always test in game for effects, allowing an in-game year or more to pass before you are convinced everything works as you intended. 
• Some properties can be added in places they previously didn't exist, the best way to know what works is testing (i.e. can you add jobs to a water pump?  hmm).
• For 'Float32' "data type" enter your value with "display as" 'default' selected in the editor window.
• You can open .sc4lot .sc4desc and other files inside of reader.
• Reading other threads after following this guide should make more sense now.  Explore the wealth of information on this site and others. 
• Never use the 'save' option on SimCity_1.dat, always 'create DAT' in patch manager.
• Sometimes v1.4 will corrupt properties of a file upon saving.  If you notice this happen modify the file with v0.9.3 which uses hexadecimal only.
• You should always test your results of mods in test cities to ensure everything works correctly, in case you create a bug such as the 'phantom slider bug'.
• Sometimes a bug like 'phantom slider bug' will require you to obliterate city to make it go away!
• I recommend toying with things yourself as much as possible; discovery is half of the fun!
• The more you explore and experiment, the more you will learn, have fun with it!

 

I hope this helps someone who has wished to modify their game, or encourages others to do so!

 

 

And don't forget, removing the file from the plugins folder will undo the changes, so don't be afraid to experiment. *1

 

Notes:

 

*1: Remember to always make back-up copies of any file you intend to modify, or using to make modifications from.  This is just good practice in case you ever have a problem.  Especially have a copy of SimCity_1.dat sitting somewhere because if your game ever corrupted; you can usually fix it by just overwriting the bad .dat with the good one.  In general make back-ups a part of your life.  Never click 'save' on your SimCity_1.dat.

 

*2:  My installation of Reader v1.4 doesn't convert integer for 'Sint64' data type properly, this may just be a problem specific to me.  Usually integer is the best way to enter the value, but if you click 'set' and see the numbers change from what you just entered, you have the same issue.  In this case just use a 'Base-10' to 'Base-16' online calculator to convert the 'decimal' number you want to use into the appropriate 'hex' value.  Then use that number and hit 'set'.  This is the same process for all value changes made in Reader v0.9.3.

 

*3:  The 'budget cost' can be adjusted, but it requires that all hospitals (or w/e adjustable budget building you are working with) are bulldozed before putting the mod in your plugins folder.  Once this bug is triggered cities can require obliteration (or restore from back-up) to make it go away.  Test budget changes to the default civic buildings in test cities, or leave budget alone.  It is safe to adjust budget of all custom buildings in y experience.  You can read more about this so-called "phantom slider bug" in the replies below. 

 

Thanks for reading!

- If you found this helpful or interesting for other reasons please let everyone know by voting this post +1 in the corner below!  

 

Please don't quote the whole post for replies, scroll wheels would overheat.

[Cyclone Boom 16,829]

A very nice tutorial, thanks for sharing.
 
(Maybe it would be worth being pinned in the SC4 Modding - Open Discussion forum).

[docj101 99]

A very nice tutorial, thanks for sharing.

 

(Maybe it would be worth being pinned in the SC4 Modding - Open Discussion forum).

 

Thanks!

 

I would be happy to see it pinned somewhere.  There isn't a guide like this on the site anymore, I felt this could be very useful.

[Yarahi 1,816]

A very nice tutorial, thanks for sharing.

 

(Maybe it would be worth being pinned in the SC4 Modding - Open Discussion forum).

Maybe even stick it right in the Omnibus-Modding section

[A Nonny Moose 8,261]

Yes to the Omnibus, but leave a link here.

[Turjan 1,048]

Very nice tutorial.

 

If the Reader doesn't accept a value change, it sometimes helps to just remove the old value (the whole line) first and add a new one afterwards.

 

Also, you hinted at it, but I would stress the point much more: Modding civics can evoke the phantom slider bug. In the words of Paeng:

 

 

Just a friendly reminder:

As with all civic buildings, their wrong use can result in the Phantom Slider Bug!

This bug will be triggered by

* uninstalling a civic building and/or
* modding the capacity or monthly costs of a civic building
without demolishing all instances of it first!

 

 

So, if you make any funding or capacity change that is supposed to alter civics buildings you already use (like all Maxis originals), you will probably cause this bug to rear its ugly head. if you don't demolish every instance of that building in your game first. This is true for all buildings where you can adjust funding with sliders in the building query. Your experience that the building reset to max funding is the harmless variant. They may also get stuck at zero funding.

[Ro-Bo 183]

Interesting tutorial.

 

Thanks to this I realized there is a newer version of iLive Reader than the one available on STEX. The older one doesn't have the "Display as" option, and I don't understand all the hex number, that what deterred me from trying (I don't have much determination anyway ). Now I have v1.4 and managed to change the jobs distribution in SPAM.

 

+1 for you, sir.

[docj101 99]

Very nice tutorial.

 

If the Reader doesn't accept a value change, it sometimes helps to just remove the old value (the whole line) first and add a new one afterwards.

 

Also, you hinted at it, but I would stress the point much more: Modding civics can evoke the phantom slider bug.

 

Thanks for helping me understand that bug.  I knew adjusting those values caused a bug, I didn't know (or remember) I could avoid it by bulldozing all hospital first.  I mentioned it more as an example of a problem someone could run into, rather then exploring its cause/solution.

 

Interesting tutorial.

Thanks to this I realized there is a newer version of iLive Reader than the one available on STEX. The older one doesn't have the "Display as" option, and I don't understand all the hex number, that what deterred me from trying (I don't have much determination anyway ). Now I have v1.4 and managed to change the jobs distribution in SPAM.

+1 for you, sir.

 

I'm glad this helped you!

 

My original link to the reader was for 'v0.9.3' because that is the only one on the STEX (as of this posting).  I also know about some issues found in 'v1.4' that have many people still using the old version.  So I had pointed readers of this guide towards the old version originally.  

 

I am using 'v1.4' as you noted.  As such I have gone back into the guide and redirected the link to 'v1.4', noting which version I used.  The process is the same in both readers, just that you have to do manual hexadecimal conversion yourself in .0.9.3; the 'display as' option doesn't exist in the old version as you say.

 

Thanks for the feedback!

[docj101 99]

Just a friendly reminder:

As with all civic buildings, their wrong use can result in the Phantom Slider Bug!

This bug will be triggered by

* uninstalling a civic building and/or

* modding the capacity or monthly costs of a civic building

without demolishing all instances of it first!

 

 

So, if you make any funding or capacity change that is supposed to alter civics buildings you already use (like all Maxis originals), you will probably cause this bug to rear its ugly head. if you don't demolish every instance of that building in your game first. This is true for all buildings where you can adjust funding with sliders in the building query. Your experience that the building reset to max funding is the harmless variant. They may also get stuck at zero funding.

 

When I first read this I thought maybe I had just been lucky for the example in my guide.  I thought maybe 6000 just wasn't a number that triggered the bug.  However, I don't think capacity change 'can' cause this bug,  not with the hospitals anyway. 

 

Based on your info I just spent a while trying to make the bug appear by changing capacity.  With each test I tried different capacity numbers and allowed the game to simulate a year or so on cheetah.  The hospitals had already been there before each test, and most had custom sliders settings in place.  The sliders stayed in place in all cases, also the budget panel remained correct.

 

I tried many different variables, choosing numbers to cover different bases:  sequential, odd, even, smaller then default, larger then default, and way over default :

 

-adjusted 'catalog capacity' by itself to: 1234, 3456, 7219, 8000, 50000

 

-adusted 'hospital patient capacity' by itself to:1234, 3456, 7219, 8000, 50000

 

-adjusted both capacities simultaneously to: 1234, 3456, 7219, 8000, 50000

 

In all cases the game didn't have a problem with the funding.  I was checking on about 8 hospitals in my city.

[Turjan 1,048]

Ok, so you think it's cost-based only? Did you make tests with that? Also, as with many bugs, you may be lucky and just not experience it, for whatever reason. I guess the recommendation that is generally given for civics plugins involving existing buildings is that, as long as they are not an ingame reward,  it's safer to make a new exemplar from the changed building.

[docj101 99]

Ok, so you think it's cost-based only? Did you make tests with that? Also, as with many bugs, you may be lucky and just not experience it, for whatever reason. I guess the recommendation that is generally given for civics plugins involving existing buildings is that, as long as they are not an ingame reward,  it's safer to make a new exemplar from the changed building.

My post directly above yours addressed exactly those tests for capacity.  Previously on my own i had tried many variations of budget changes.. they all make the bug appear.  I tried way more tests with budget cost then capacity, and couldn't prevent it from occurring with budget. 

 

I'm glad i know i can change the budget costs by bulldozing all of em first.  I guess i should have thought of trying that.

 

Covering the existence of the 'phantom slider bug' and how to avoid it is good information for a beginners guide.  I'm glad you brought it up, thanks!

[Turjan 1,048]

 

my post directly above yours addressed exactly those tests for capacity.  previously on my own i had tried many variations of budget changes.. they all make the bug appear.  i tried way more tests with budget cost then capacity, and couldn't prevent it from occurring with budget. 

 

oh, and i'm glad i know i can change the budget costs by bulldozing all of em first.  i guess i should have thought of trying that.

 

Good tests. Makes everything clear .

[timmie 988]

I have moved the topic to the appropriate forum.

-timmie

[MandelSoft 2,769]

Nice and useful tutorial for beginners, docj101. I've pinned this tutorial

[LivingInThePast 364]

I tried working some things, but I couldn't bring up that "Patch Manager" window...

[T Wrecks 10,209]

Can you describe the problem exactly? Did you click, and no window opened? What exactly did you do, and what exactly did or did not happen?

[LivingInThePast 364]

I right-clicked and added my changes to the patch, and according to the guide, a window was supposed to come up at that point, but it didn't, and I couldn't create a new .dat based on my changes.

[docj101 99]

I right-clicked and added my changes to the patch, and according to the guide, a window was supposed to come up at that point, but it didn't, and I couldn't create a new .dat based on my changes.

In step 10:  you right-click the hospital, then click 'add to patch', then you must click the 'patch manager' button that was previously greyed out.  When you click 'add to patch' the 'patch manager' doesn't open automatically because it assumes you might want to add more items to it.  You can close the navigator window after clicking 'add to patch' if you want; the item has already been added to 'patch manager'.

[LivingInThePast 364]

Thanks! I got it now!

[docj101 99]

This is said elsewhere, but relevant here:  With the Extra Cheats Plugin DLL, you can use it as a debug tool for mods you have created.  I call it advanced query.  You can check on a building's power and water consumption even when it isn't normally reported.  Or you can check on the number of jobs being supplied by a building: broken down by wealth type.  Among other things.  You do this by holding down ctrl+shift+alt while hovering on a building with the query tool selected (assuming the .dll is installed).

[z1 566]

You do this by holding down ctrl+shift+alt while clicking on a building with the query tool selected (assuming the .dll is installed).

 

Minor correction:  This works only if you have the query tool selected and hover over the building, but do not click on it.  If you click on the building and then try this, nothing happens.  Also, if you have this display on and then click on the building, the display goes away.

[docj101 99]

 

You do this by holding down ctrl+shift+alt while clicking on a building with the query tool selected (assuming the .dll is installed).

 

Minor correction:  This works only if you have the query tool selected and hover over the building, but do not click on it.  If you click on the building and then try this, nothing happens.  Also, if you have this display on and then click on the building, the display goes away.

 

lol, you are right.  hover is what I meant to say.  people would have realized that on their way to click anyway.

[Anna_Kasaeva 0]

Fantastic guide, I'm going to try this! Thank you.

Unfortunately ilives reader doesn't work for me, each time I click "navigation" it stops responding and closes the program.

Scrap that, finally I have it working, does anybody know of a good converter for the binary code? I found this http://www.binaryconvert.com but not 100% sure if it's what I need.

Sorry I write so much rubbish

Anna

[z1 566]

Welcome to Simtropolis!

 

For the Reader, I think you want a hexadecimal converter.  Assuming you're using a recent version of Windows, the Windows calculator is fine for this job.  Just go into Programmer Mode (View->Programmer or Alt-3).  Then you can type in numbers and convert between hex and decimal either with the radio buttons on the left or with the F5 and F6 keys.

 

Sorry I write so much rubbish

 

You have two short posts here, with no rubbish to be found anywhere!  You are simply using these forums for the purpose for which they are intended.

[Anna_Kasaeva 0]

I'm using Windows 8. Is there a limit to the values which are edited? Like a maximum or can it be any amount? I'll check out the calculator, thanks.

I not sure I make sense as I rely on machine translation.

Anna.

[z1 566]

The Windows 8 calculator can handle any numbers that are required by the Reader.

[jeffryfisher 2,176]

Being a newbie, I found a newbie stumbling block to beware of:

 

After navigating to a building and double-clicking on a property, the controls on the property dialog box (e.g. the "Set" button) may be frustratingly gray and stay that way. If so, then the building's "parent cohort" (immediately under the building's name in the navigator) may offer editable versions of the same properties.

 

After editing one of those (a water pollution radius), I see the parent's new value reflected in the building's properties (I smell O-O inheritance). I am about to find out if editing such a parent is a "bad idea". If you never see me in the forums again, it's because my computer blew up 

[T Wrecks 10,209]

It can't be THAT bad.

 

As the name suggests and as you already guessed, a parent cohort is used to store some values that all its "children" (=objects assigned to this parent cohort) will share. So if you had value X of a particular building in mind, value X for this building is derived from a parent cohort, and you modify value X in the parent cohort, then there may be other buildings for whom value X has also changed because they hook into the same parent cohort. Unless you set totally extreme values, this shouldn't blow up anything.

[jeffryfisher 2,176]

Well, I'm still here, but I don't think my change took hold. Either I got the wrong exemplar or else something hiding at the end of my plugins folder is overriding my work (or SPAM somehow misspelled a critical ID in its Jez Knight Acres mod... or CAM changed something in a way that defeats the later SPAM mod).

 

One of the perils of modding is that one may do the right edit with the tool, but that edit might do nothing because another file hides its value(s). If I ever figure out why exactly one farm is polluting my water, then I'll have learned a thing or two about how this game works.

 

Is there a tool that can analyze an entire plugin folder to tell what defs are going to be used (and what dat file each comes from)? Maybe I can datpack the whole folder and then edit that...

[z1 566]

Cleanitol does a lot of what you want.