User Tools

Site Tools


gamemanual:installing_mods

Installing Mods

Follow this tutorial to manually install a mod file.



How It Works

A Mod file is a folder containing all the files used for the mod. Using the Settings Editor program, you select which mod you wish to use in the game. When you start the game, the files in the mod overwrite the default game files. To return to the Default files, you simply use the Settings Editor program to reload the “Default” mod.


Unpacking

Most likely you received the mod in a compressed file format. Depending on the format, you may need third party software to decompress it. The following list are names of software needed for each file extension:

The following programs are for Windows. We expect Linux and OSX users to know their software. :)

ExtensionProgram NameURL
.zip Windows None, built into windows.
.7z 7zip www.7-zip.org
.rar winRAR or 7zip www.rarlab.com/download.htm OR www.7-zip.org

Please note, due to this wiki being viewable in game, external links have been disabled. Copy and paste, or type the URL in your address bar to visit the websites.

The contents of the map should be in one folder with the same name as the map name.



Moving the Folder to Mods

Next you should locate your Mod folder. This is normally in the game's InstallPath/media/Mods folder. If you're using Steam, see Steam: How to Access Installation Folder to open the InstallPath of the game.

Now, simply copy and paste the entire folder for the downloaded mod into the InstallPath/media/Mods folder.



Selecting an Installed Mod

First, we need to open up the Settings Editor. If using Steam, select GearCity from your list of installed games and click “Play”






You'll be presented with a second window allowing you to select the launch options. Select “Launch Configuration Tool” then click “Play”.






This is the Settings Editor. Here we can change video settings, in game settings, and select the modification we use. As noted in the picture, click the “Modifications” tab to continue.










This is the “Modification Selection” tab. To get more information about a mod, select the mod from the drop down, labeled #1 in the picture.

The Editor will give you a description of the mod, a listed of supported maps, and a list of features.

If a map you wish to play is not supported by a mod, then the game will use the default map files for the map. However, The mod's non-map specific capabilities will be supported. Inside the game, supported maps will be listed in green. Unsupported maps are listed in red.

When you found the map you want, make sure it is selected in the drop down box (#1 in the picture) and click “Save” (#2 in the picture.)

Now you're ready to play the game with the selected mod. Close the settings editor and open up GearCity!



Troubleshooting

If something seems wrong, here is where you might find a solution.

Mod Not Listed in Settings Editor

There could be 3 reasons for this:

  1. Did you extract the mod from the compressed file? No? See: Unpacking
  2. Did you copy the entire folder containing the mod to the InstallPath/media/Mods folder? No? See: Moving Mods
  3. Inside the folder with the mod data, does it contain a ModFileForGame.xml file? If not, then the issue is with the mod and not with you. Contact the Mod Maker.



Game Won't Start

Most likely there is an issue with one of the files in the mod. Check How to Read Log File to figure out which file is broken. Then contact the Mod maker. You may want to include the log file when contacting the mod maker.

Game Crashes When Starting New Game

Most likely there is an issue with the AI files, Components files, Turn Events files, City Files, or the Map it self in the Mod. Check How to Read Log File to figure out which file is broken. Then contact the Mod maker. You may want to include the log file when contacting the mod maker.

Game Crashes Ending Turn

Most likely there is an issue with the Components files, Turn Events files, or Review files in the Mod. Check How to Read Log File to figure out which file is broken. Then contact the Mod maker. You may want to include the log file when contacting the mod maker.

Game Crashes Any Other Places

Most likely there is missing artwork somewhere, such as logo files. Check How to Read Log File to figure out which file is missing. Then contact the Mod maker. You may want to include the log file when contacting the mod maker.

gamemanual/installing_mods.txt · Last modified: 2018/08/15 11:56 by admin