This tutorial is for use with Phase Seven of the StoryProgression Mod.




With the introduction of Phase Seven StoryProgression, the town personalities are now implemented using XML tuning.

That means that end-users can now write their own full fledged clans, and have them rampage through the town with wild abandon.

Those of you aware of the Careers Tutorial will notice distinct similarities in this tutorial. The process is pretty much exactly the same. You create a new package, renumber all the Instances, and then change the XML to suit your needs... Simple.



Before You Begin


One must be acquainted with the use of a Sims 3 Package Editor. I use Packer personally, but S3PE is also an obvious choice, and there are others available.

You must also know how to read XML and understand the format enough to at least copy/paste existing XML and change it.

Steps


  1. Create a copy of the NRaas_StoryProgressionOthers.package and rename it to be something new. The name of file can be whatever you feel like. For this example I will call the file "ClanOfBob.package".
  2. Open your package with a package editor (I will be using S3PE during this guide, so steps may vary)
  3. Enable the "Names" and "Tags" options so you can see the Name and Tag columns on the listing
  4. Within the package you will find the following:
    • 01594630409241.dll - There are two files named this. One is the bootstrap DLL, and the other is the XML file containing the references to the other XML in the package.
    • NRaas.StoryProgression.Others.Scoring - This XML file contains the scoring elements for the personality
    • NRaas.StoryProgression.Others.Personalities - This XML file contains the scenarios for the personality
    • Strings_* - These files contain the language localization strings used by the personality
  5. First thing we must do is change all the Instance IDs so they do not conflict with the original set of personality data
    • Choose a name for your personality data... Make it unique. In this example I will use the following names:
      • ClanOfBob.Scoring
      • ClanOfBob.Personalities
    • Run the "Tools \ FNV Hash" menu operation and enter in one of the new names. Press the "Calculate" and copy the "FNV64" value to somewhere safe.
      • The results of the example names:
      • 0xA3505857540360A6
      • 0xB35E1C7288A066E
  6. Now double click on the "NRaas.StoryProgression.Others.Scoring" line in the listing. In the Resource Details window, replace the ** "Instance" with the appropriate new ID. And then change the "Name" to your unhashed name.
    • Repeat this process for the other three files.
  7. You should probably save now.
  8. Now you may open each file using the "Editor" button and change the data within them. You can delete all the data for the default careers, as that data is still in the original copy of the package.
  9. Once you have completed filling in those files, you must now create the language localization file for at least English.
  10. Firstly, you must choose a new Instance ID for the STBL files. I will simply reuse the "ClanOfBob.Scoring" ID.
    • The first two digits of the Instance for a STBL file is the language it is associated with. Change the first two digits to "00" for the English STBL (you can see the other codes in the existing file).
    • So the Instance in this example would be 0x00E5B989933FAD8E for the English file.
    • Note: if you don't intend to make your personality publicly available, it is only necessary to change the STBL file for your language.
  11. For creation of the STBL, I use a separate utility called STBL.exe . The application is available in the Language Localization forum where I store all the translation files for my mods.
    • It takes an XML file containing the keys and creates STBL file that can be imported into a package.
    • An example of one such XML string table is available in the Language Localization forum.
  12. Once you have completed importing the required string tables. Save the file.
  13. Next step... Exposing "ClanOfBob.package" to the StoryProgression Mod itself.
  14. Download the attached zip and extract to its own folder. In it you will find two files. An application called BootStrapCreator.exe and a DLL called NRaasBootStrap.dll
  15. Run BootStrapCreator.exe and the program will create a new DLL with a randomly generated name. This is your personal scripting mod dll.
    • Since the name is random, I will use 01234567890123.dll in this example.
  16. Go back you package in S3PE. Look for the S3SA line that says 01594630409241.dll . There are two, so make sure you select the S3SA tagged line.
  17. Press the "Grid" button, select the "Import/Export" item and choose "Import" to load your newly generated scripting mod into that location, and then Commit.
  18. Now take the full name of your DLL (including extension and '.') and FNV64 it. In the case of 01234567890123.dll, the hash is 0xE6911C8A4E3421EA.
  19. Replace the Instance ID for BOTH lines that show 01594630409241.dll . Remember to change BOTH the _XML and S3SA elements to the new Instance ID.
  20. Rename the 01594630409241.dll elements to match your script dll name... In my case: 01234567890123.dll
  21. Now open the _XML element 01234567890123.dll . In it is the <StoryProgression> data that links your data-set into the StoryProgression Mod.
  22. Within that file you need to enter a reference to your newly created XML files. Here is what the XML for this example would look like:
    • <?xml version="1.0" encoding="utf-8"?>
      <StoryProgression>
      <MethodFile>
      <File></File>
      </MethodFile>
      <MethodFile>
      <File>ClanOfBob.Scoring</File>
      </MethodFile>
      <PersonalityFile>
      <File></File>
      </PersonalityFile>
      <PersonalityFile>
      <File>ClanOfBob.Personalities</File>
      </PersonalityFile>
      </StoryProgression>
  23. Save that file.
  24. Now comes the big step : Setting up the Scoring and Personalities XML itself. I will go into detail on that in later posts.
  25. Finally, copy the "ClanOfBob.package", into the appropriate location in your Mods folders.
  26. Run the game, and your new personality should appear.

Related Pages