Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 3.75 KB

README.md

File metadata and controls

65 lines (46 loc) · 3.75 KB
Raw

EdB Prepare Carefully

Contributing Translations

The more translations, the better--they are a great contribution to the mod community. However, while it is appreciated that people take the time to translate the mod to other languages, it's difficult to keep up with those contributions. Every addition or change to a translation requires a new release of the mod, and taking on that additional effort is not possible.

Therefore, translation pull requests will not be merged into the project. Instead, please consider creating a standalone translation mod for your language. These mods don't include any code--they simply include the translation resources for a given language. With this approach, you can make changes and additions at your own pace, and you can take on the responsibility of releases for the translation.

Building Prepare Carefully

The solution file was created using Xamarin Studio/MonoDevelop, but it should also work in Visual Studio. Note that the project targets the older 3.5 version of the .NET framework used by the Unity engine on top of which RimWorld is built.

Note that the solution has dependencies on the following RimWorld DLLs:

  • Assembly-CSharp.dll
  • UnityEngine.CoreModule.dll
  • UnityEngine.IMGUIModule
  • UnityEngine.InputLegacyModule
  • UnityEngine.TextRenderingModule

Copy those dependencies from the RimWorld game directory into the "Libraries" directory. Be sure to make copies of the originals--don't accidentally move/delete them from the original game directory.

The solution also has a dependency on the following third-party DLL:

  • 0Harmony.dll

The Harmony DLL is available from https://github.com/pardeike/Harmony/releases and should also be placed in the "Libraries" directory. Prepare Carefully uses version 2.0.0.8 of Harmony. When you download Harmony, you'll see multiple versions of the DLL organized into various directories. Be sure to use the one in the "Release/net472" directory.

Only if you must create a build that also supports RimWorld 1.0, you will need to get the DLL from the latest Prepare Carefully release for 1.0, along with the DLL for Harmony 1.2. Place these DLLs into the Resources/Assemblies directory.

The result of the build will be the following DLL:

  • EdBPrepareCarefully.dll

This DLL must be packaged alongside the contents of the Resources directory to create a working mod. The DLL built by the project should be placed inside a 1.1/Assemblies directory along with the Harmony DLL. The directory structure should look like this:

+ EdBPrepareCarefully
  + 1.1
    + Assemblies
      - 0Harmony.dll
      - EdBPrepareCarefully.dll
  + About
  + Assemblies
  + Defs
  + Languages
  + Textures
  - CHANGLELOG.txt
  - LICENSE
  - LoadFolders.xml

If Windows is the OS on which you're developing, you don't need to manually create the mod directory. Instead, you can automatically package up the mod by running the dist.bat script. This will copy all of the mod resources and the DLL into a dist/EdBPrepareCarefully directory. Copy this EdBPrepareCarefully directory into your RimWorld Mods folder to use the mod in your game.

Versioning

Prepare Carefully uses a versioning scheme inspired by semantic versioning that combines the major/minor version of RimWorld with the major/minor version of the mod to end up with the following format:

{RimWorld major version}.{RimWorld minor version}.{mod version for this RimWorld version}

Other conventions used to determine the mod version numbers:

  • Mod version numbers always start at 1 and never start at 0

Some examples:

  • 0.18.2: The second release of the mod for the Beta 18 version of RimWorld
  • 1.0.11: The eleventh release of the mod for RimWorld 1.0
  • 1.1.1: The first release of the mod for RimWorld 1.1