Difference between revisions of "Sims 3:Creating a game compatible Visual Studio project"

Revision as of 11:16, 19 January 2013

Step 1: Create a New Project

• Set the framework version to .NET Framework 2.0.
• Use the Visual C# Class Library template.
• Preferably prefix the name of the library with your name / handle. Eg, Gibbed.Sims3Game.Test is what I would use. —Rick

Step 2: Remove all existing references

• Select all references, this is usually System, System.Data, and System.Xml..
• Right-click the selected references, and select Remove.

Step 3: Set the project to not reference mscorlib.dll

• Open the project properties.
• Set the active configuraiton to All Configurations.
• Change to the Build tab.
• Click Advanced to open the Advanced Build Settings window.
• Check Do not reference mscorlib.dll and click OK.
  • VS 2010 Users: In addition to ticking "Do not reference mscorlib.dll," you will have to add the mscorlib reference manually. This will be discussed in Step 6.
  • VS 2012 Users: You can skip this step. VS2012 does not have an option not to reference mscorlib. You will have to do it manually. This will be discussed in Step 6.

Step 4: Add references to the Sims 3 assemblies

You will need to have already extracted and decrypted the Sims 3 assemblies to do this step. See Getting Started with Scripting Modding if you haven't done this already.

• Right-click the References item in the Solution Explorer.
• Select Add Reference....
• Select the Browse tab.
• Select all of the Sims 3 assemblies. The assemblies you want to add are mscorlib, ScriptCore, SimIFace, Sims3GameplayObjects, Sims3GameplaySystems, Sims3StoreObjects, Sims3Metadata, System, System.Xml, and UI.
  • VS 2010 & 2012 Users: Skip the mscorlib.dll. Step 6 will show you how to add this reference to your project.
• Click OK.

Step 5: Set the references to not Copy Local

• Select all references.
• Set the Copy Local property to False.

Step 6: Extra steps for VS 2010 & 2012 Users

VS 2010 and 2012 Users will now have to manually alter the .csproj in order to reference the correct mscorlib.dll. The process is the same for both versions of VS.

1. Save your project and close VS.
2. Go to the folder where your VS project is saved and find the .csproj file for your project.
3. Right-click on the file and choose Edit with Notepad++. If you don't have Notepad++ you may need to choose NotePad from a list of programs.
   • Tip: In Notepad++, set the language to XML, so you can easily check for matching tags.
4. Between the last </PropertyGroup> and the the first existing <ItemGroup>, add this:

<ItemGroup>
    <Reference Include="mscorlib">
      <HintPath>... Path to where Sims 3 mscorlib.dll is on your computer ...</HintPath>
      <Private>False</Private>
    </Reference>
</ItemGroup>

Note: you can also just drop the everything between the <ItemGroup></ItemGroup> tags above into the same <ItemGroup></ItemGroup> as your other references.

5. Save the .csproj and close Notepad++. Open your project in VS now. If you get an error when opening the project, you probably forgot to close a node somewhere in your .csproj, or you may have used the wrong path for mscorlib.

VS 2012 Users: You will see the following warning when you compile:

1>C:\Windows\Microsoft.NET\Framework\v4.0.30319\Microsoft.Common.targets(1578,5): warning MSB3270: There was a mismatch between the processor architecture of the project being built "MSIL" and the processor architecture of the reference "Sims3Metadata", "x86". This mismatch may cause runtime failures. Please consider changing the targeted processor architecture of your project through the Configuration Manager so as to align the processor architectures between your project and references, or take a dependency on references with a processor architecture that matches the targeted processor architecture of your project.

To prevent this warning, you must change your project from Any CPU to x86. Use the drop down menu in the second tool bar to do this. You may need to use the Configuration Manager to add x86 to the drop down menu.

Step 7: Fin

You're now ready for coding. :)