MTS has all free content, all the time. Find out how YOU can help to keep it running. Tell me how...

Featured upload! XML Injector version 2

by scumbumbo Posted 24th Jan 2019 at 9:22 AM - Updated 26th Mar 2019 at 11:43 PM by scumbumbo : Version 2 Released (New Features)
189 Comments / replies (Who?) - 19 Feedback Posts, 2 Thanks Posts
This is a featured upload! It showcases the best talent and creativity available on MTS and in the community.
Version 2 Released
  • Contains new features which may be required by some mods.
  • Don't forget to remove version 1 when you upgrade!

Description

The XML Injector for The Sims 4 is a mod library to allow mods that would normally require a script for simple changes to instead use a custom snippet. The library provides the scripting, and the modder can release their mod without having to concern themselves with writing, compiling and maintaining a script. Currently the XML Injector snippet handles adding interactions to game objects in a variety
of ways with a simple XML definition.

Player Info

If you just play the game then you only need to download and install this library mod if another mod you download tells you that you must have this installed. On it's own this mod does nothing, it works in the background to make other modders able to code their mods more easily.

If another mod does inform you that this mod is required for it to work, then you should proceed to download and install this. You do not need to download the Modder's Documentation file, this contains the technical information for modders to reference.

Installation is simple. The file you download will contain two files, a script named XmlInjector_Script_v2.ts4script and XmlInjector_Test_v2.package.

Extract both of these files from the download file into your game Mods folder. You should install it directly into your Mods folder, and not a subfolder, in order to ensure that it can be easily located if you need to upgrade the script to a newer version.

The current version of the XML Injector is version 2, and denoted by the _v2 in the filenames. It has been written to work with the most recent game patch, 1.50.67 (February 21, 2019).

Once both files are installed, you must also ensure that script mods are enabled in your game options. This is very important as, though the XML Injector allows other mods to eliminate their scripts, the XML Injetor does the scripting for them and so script mods must be allowed in your game.

After installing the XML Injector, you should test to make sure it is working properly. The included test package adds several test interactions to several game objects. Choosing one of these "XML Injector Test" interactions from the pie menu should display a notification that the XML Injector is working properly. If you do not see these test interactions then the XML Injector is not installed properly and will not work for mods that depend on it.

The "XML Injector Test" test interactions can be selected from any of the following six locations in the game.
  • On a household's mailbox
  • Any of the game's computer objects
  • Clicking on any Sim
  • In the "Friendly" chat choices when clicking on another Sim
  • From a Sim on the relationship panel
  • From the "Household" phone category
There is not really any need to test more than one of these choices, any single one should suffice. The test is primarily in so many places in order to serve as a useful reference for modders to see how to code their own mods.

Once you have verified that the XML Injector is working, you may remove the XmlInjector_Test_v2.package file and test interactions will no longer appear on your pie menus.

The script file should remain in your Mods folder. If the script is removed, other mods which depend on it will no longer operate properly.

You should check back here occasionally, particularly a day or two after game updates if it stops working, to see if the mod has been updated with any important additions or fixes for new game patches. In the future, a mod you download may specify that it requires features from a version newer than the one you have installed, and again this is an important reason to keep the mod installed in the main Mods folder so it can always be located easily and the version number verified.

Modder Info

The primary purpose of this mod is to eliminate the need for modder's to write, compile and maintain their own scripts for the simple tasks of modifying the game's XML tunings (e.g. _super_affordances list). It currently supports:
  • Add interactions to game objects. The game objects can be selected by instance number, an existing interaction (e.g. sink_washHands), or a partial name search.
  • Add interactions to the Sim's object.
  • Add interactions to the relationship panel.
  • Add interactions to the phone panel.
  • Add interactions to AffordanceLists ("Friendly" mixers, etc.)
  • Version 2
    • Test that XML Injector v2 or higher is installed.
    • Test that that the installed version of XML Injector supports your mod.
    • Add loot actions to LootActions and RandomWeightLoot tunings.
    • Add buffs to traits.
    • Add name and object relationship components to game object tunings.
    • Add states and state_triggers to object tunings.

By offloading these tasks to a shared script, controlled by a simple XML snippet that you include in your mod package, this eliminates the need for you to include a script. In addition, if future game updates alter the method that these XML tunings must be modified in a script, this library will be promptly updated with any necessary fixes - and no changes will be required to your mod.

The majority of the documentation for the library is contained in the Modder's Documentation. This contains the following resources:
  • A PDF document with the technical details on creating an XmlInjector snippet tuning, including several examples.
  • The raw XML and STBL files contained in the test package.
  • A tuning description file for the XmlInjector snippet. If you use the TS4 Tuning Description Browser, you can place this file into your snippets folder where you have stored the EA TDesc files to view it within the browser.
  • The script source files for reference. At least one other script modder should acquaint themselves with the code (feel free to ask me any questions on how something works!) in the event that I am unable to update it myself for whatever unplanned and involuntary reason.

Once you've setup your mod to use an XmlInjector snippet, you should inform players who download your mod to obtain and install a copy of the XML Injector from this download page. Do not distribute the library with your own mod. This ensures that players have only one copy of the script installed, and that they can easily determine if they have the latest version installed and know where they can get the most recent updates if required.

The XML Injector can be extended to update other tunings. If you have any ideas, feel free to ask if they can be implemented. Ideal candidates for new features would be common tuning changes that would otherwise create the possibility of mod conflicts without a script. More complex or rare changes would not receive any priority for implementation as the mods that make those complex changes are likely to require a script for other reasons. The main goal is to allow other mods to be implemented and distributed without requiring their own scripts.

If you have any questions or run into technical difficulties, please post here on the mod library's discusion thread. In addition, some alternative methods of contacting me are given in the PDF documentation.

Thank you to all the modders who have tested, and given me ideas and encouragement for implementing this library snippet!

Thank you to Triplis for joining the development team and creating new features for future XML Injector versions!

You must have the expansion, game version or stuff packs listed below installed to use this custom content. Please see the post text for any exceptions.

Sims 4
Built with Game Version: 1.50.67
Key: - File was updated after upload was posted
Filename - Tip: You can click the magnifying glass to see the archive contents Size Downloads Date
XmlInjector_v2.zip | XML Injector Version 2

Size: 13.0 KB · Downloads: 105,375 · 26th Mar 2019
13.0 KB 105,375 26th Mar 2019
XmlInjector_Modders_Documentation_v2.zip | Documentation for Modders

Size: 1.30 MB · Downloads: 27,544 · 26th Mar 2019
1.30 MB 27,544 26th Mar 2019
Don't forget to Thank the creator after downloading! Use the Thanks button located above the screenshots above.
Basic Download and Install Instructions:
1. Download: Click the File tab to see the download link. Click the link to save the .rar or .zip file(s) to your computer.
Read the upload description for installation instructions. If nothing else is specified, do the following:
2. Extract: Use WinRAR (Windows) to extract the .package file(s) (if included, ts4script as well) from the .rar or .zip file(s).
3. Cut and paste the .package file(s) (if included, ts4script as well) into your Mods folder
  • Windows XP: Documents and Settings\(Current User Account)\My Documents\Electronic Arts\The Sims 4\Mods\
  • Windows Vista/7/8/8.1: Users\(Current User Account)\Documents\Electronic Arts\The Sims 4\Mods\

Need more information?
  • Anyone can use both .rar and .zip files easily! On Windows, use WinRAR.
  • If you don't have a Mods folder, just make one.
  • Mod still not working? Make sure you have script mods enabled
 
189 Comments / Replies (Who?) - 123 Feedback Posts, 51 Thanks Posts
Hide Thanks Posts for this thread (Show only feedback)
Page 5 of 8
Test Subject
#101 Old 24th Sep 2019 at 10:13 PM
I am also not able to use workout equipment when using this. I had to go through all my mods. I have a ton. I narrowed it down to this. When this is removed everything works fine. It was working okay before the latest update.
Test Subject
#102 Old 25th Sep 2019 at 3:56 AM
Quote:
Originally Posted by virtualyaya77
I am also not able to use workout equipment when using this. I had to go through all my mods. I have a ton. I narrowed it down to this. When this is removed everything works fine. It was working okay before the latest update.


Hi, I am not able to use any exercise equipment either. I narrowed it down to this mod.
Test Subject
#103 Old 25th Sep 2019 at 11:26 AM
I'm getting last exception texts with only this in them and nothing else, "<?xml version="1.0" ?><root>
</root>"
It's weird, I've never had version 1.0, I started using XML with version two.
Test Subject
DELETED POST
27th Sep 2019 at 1:44 AM
This message has been deleted by AnimangaGirl.
Test Subject
#104 Old 30th Sep 2019 at 10:46 PM
Triplis' update still working fine in my fully updated and patched game and workout equipment working fine too. Thanks Triplis!
Lab Assistant
DELETED POST
3rd Oct 2019 at 11:06 PM
This message has been deleted by StormyWarrior8.
Lab Assistant
#105 Old 4th Oct 2019 at 3:38 AM
Quote:
Originally Posted by Triplis
Since Scumbumbo hasn't been around lately (that I'm aware of) and I have some familiarity with the tool, I looked into this being broken after the September 5th patch. Deaderpool ended up pointing me in the direction of what had changed in the official code causing the error I was seeing and I applied what appears to be the needed fix to the mod. What was broken seems to be working now.

So I'm posting a message to share the fixed version, one the injector itself and one the modder's documentation, including the uncompiled files with the one I changed.

If you are a modder, I recommend testing this with your mods that need it before notifying people about the change. That way if there's something still broken that I missed, you can catch it first.

- Triplis


Hi Triplis!

Can I include the script file in my mod for download here on MTS (crediting you in the description)? Or should I just include the download link for your mod in my mod description?
Mad Poster
#106 Old 4th Oct 2019 at 3:12 PM Last edited by Menaceman44 : 5th Oct 2019 at 3:48 PM.
I realise I am not Triplis and cannot answer for them but I would suggest linking here would be best practice in case it needs another update in the future. That way you won't accidentally be providing players with outdated scripts.

My deviantART, MTS Yearbook Origin ID = Alistu
Lab Assistant
#107 Old 4th Oct 2019 at 4:22 PM
Quote:
Originally Posted by Menaceman44
I realise I am not Triplis and cannot answer for them but I would suggest linking here would be best practive in case it needs another update in the future. That way you won't accidentally be providing players with outdated scripts.


Good suggestion! That's what I will do then. Thanks!
Field Researcher
#108 Old 5th Oct 2019 at 12:59 AM
Thank you, Triplis!
Test Subject
DELETED POST
5th Oct 2019 at 8:45 AM
This message has been deleted by taoron.
Test Subject
DELETED POST
10th Oct 2019 at 10:55 PM
This message has been deleted by BrazenLotus.
Test Subject
#109 Old 16th Oct 2019 at 6:40 PM
I have not been able to get this to work. I followed the instructions and extracted both files into my mods folder directly but when I play my game, I don't get any of the testing actions.
Mad Poster
#110 Old 16th Oct 2019 at 9:11 PM
Quote:
Originally Posted by VixenThief
I have not been able to get this to work. I followed the instructions and extracted both files into my mods folder directly but when I play my game, I don't get any of the testing actions.

Are you using the version from the main download page or the updated version by Triplis on page 4?

My deviantART, MTS Yearbook Origin ID = Alistu
Lab Assistant
#111 Old 17th Oct 2019 at 3:34 AM
Quote:
Originally Posted by Menaceman44
Are you using the version from the main download page or the updated version by Triplis on page 4?

Update version Xml Injector from page 4 it causing the Last exception.
Test Subject
#112 Old 17th Oct 2019 at 9:30 PM
Quote:
Originally Posted by Menaceman44
Are you using the version from the main download page or the updated version by Triplis on page 4?

I downloaded the version 2 zip from this mod's download tab. I don't understand what you mean by page 4 or Triplis.
Mad Poster
#113 Old 17th Oct 2019 at 9:37 PM
Quote:
Originally Posted by VixenThief
I downloaded the version 2 zip from this mod's download tab. I don't understand what you mean by page 4 or Triplis.

The version available from the download tab is outdated. Triplis is another forum member and has updated the mod so that it works again. It can be downloaded from their post on page four of these comments. This is page five so you need to go back one to find it.

My deviantART, MTS Yearbook Origin ID = Alistu
Test Subject
#114 Old 20th Oct 2019 at 7:00 PM
Quote:
Originally Posted by Menaceman44
The version available from the download tab is outdated. Triplis is another forum member and has updated the mod so that it works again. It can be downloaded from their post on page four of these comments. This is page five so you need to go back one to find it.

Ah ok. Im new to modding with scripts and dont look at the comments much, thank you for the help.
Test Subject
THANKS POST
#115 Old 23rd Oct 2019 at 7:25 PM
for some reason I cant workout or cook with this mod in and im using the page 4 update workout works when I take it out but I still cant cook I don't know what I am doing wrong or why its happening is anyone having this problem??
Test Subject
#116 Old 24th Oct 2019 at 1:24 AM
Help
Quote:
Originally Posted by Triplis
Since Scumbumbo hasn't been around lately (that I'm aware of) and I have some familiarity with the tool, I looked into this being broken after the September 5th patch. Deaderpool ended up pointing me in the direction of what had changed in the official code causing the error I was seeing and I applied what appears to be the needed fix to the mod. What was broken seems to be working now.

So I'm posting a message to share the fixed version, one the injector itself and one the modder's documentation, including the uncompiled files with the one I changed.

If you are a modder, I recommend testing this with your mods that need it before notifying people about the change. That way if there's something still broken that I missed, you can catch it first.

- Triplis


Even though it works for most people I still need help fully downloading it I have the WinRAR and I bring the file over, yet it still wont work for me.
Test Subject
#117 Old 24th Oct 2019 at 11:22 AM
MCD is telling me that the script file is a broken mod.
Test Subject
THANKS POST
#118 Old 25th Oct 2019 at 9:50 PM
this is a great mod but it's not working for me
Test Subject
#119 Old 31st Oct 2019 at 12:20 AM
Default Help
Quote:
Originally Posted by Menaceman44
The version available from the download tab is outdated. Triplis is another forum member and has updated the mod so that it works again. It can be downloaded from their post on page four of these comments. This is page five so you need to go back one to find it.

That version wont work for me
Test Subject
#120 Old 13th Nov 2019 at 12:16 PM
Thank you to Triplis for fixing the mod, it would be great if it could get updated again. The version on page 4 doesn't work for me, it gives me a ton of last exception files.
Test Subject
#121 Old 13th Nov 2019 at 7:50 PM
so whenever i try to open the website on which you download the mod, the page doesn't load at all? it just shows me an empty page.
it tells me it's taking too long to load. i have tried deleting my cache, cookies, tried incognito mode, tried a different browser but absolutely nothing works.
Page 5 of 8