modtools:aieditor
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
modtools:aieditor [2017/05/13 11:53] – [The Editor] admin | modtools:aieditor [2019/02/17 17:47] – [AI Variables] admin | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== AI Editor ===== | ===== AI Editor ===== | ||
- | GearCity stores all AI companies in an XML file. Due to some variables requiring a City ID, //AI.xml// files are specific to // | + | GearCity stores all AI companies in an XML file. Due to some variables requiring a City ID, //AI.xml// files are specific to // |
- | Each AI node also contains a logo file. These files should be shipped with the map or added via the mod system as supplemental artwork. | + | Each AI node contains a logo file. These files are shipped with the map or added via the mod system as supplemental artwork. |
//If you add/edit an AI company, and the game crashes, check the [[ModTools: | //If you add/edit an AI company, and the game crashes, check the [[ModTools: | ||
Line 11: | Line 11: | ||
===== Mod Tools ===== | ===== Mod Tools ===== | ||
- | To access the AI Editor, you must open the Mod Tools. See [[ModTools: | + | To access the AI Editor, you must open the Mod Tools. See [[ModTools: |
- | The AI Editor is available | + | The AI Editor is located |
+ | \\ | ||
+ | \\ | ||
===== The Editor ===== | ===== The Editor ===== | ||
This is the AI Editor. Below we'll walk you through what each part of the Editor is for. | This is the AI Editor. Below we'll walk you through what each part of the Editor is for. | ||
Line 33: | Line 35: | ||
- Lists the AI companies entered into the editor. | - Lists the AI companies entered into the editor. | ||
- Clears AI Variable data so a new AI company can be generated from scratch. | - Clears AI Variable data so a new AI company can be generated from scratch. | ||
- | - Adds/ | + | - Adds the new AI company |
- Removes selected AI from list of AI companies entered into the editor. | - Removes selected AI from list of AI companies entered into the editor. | ||
| | ||
+ | \\ | ||
+ | \\ | ||
===== Files And How it Works ===== | ===== Files And How it Works ===== | ||
- | When the player starts a new game on a selected map, the // | + | When the player starts a new game on a selected map, the // |
The game can only load a random number of AI from an //AI.xml// file or all the AI from the file. With that in mind, multiple AI files may be needed. For example, Base City Map has 3 //AI.xml// files. One with 10 large companies, one with 25 large companies, and finally one that has 300 AI companies and is used for the " | The game can only load a random number of AI from an //AI.xml// file or all the AI from the file. With that in mind, multiple AI files may be needed. For example, Base City Map has 3 //AI.xml// files. One with 10 large companies, one with 25 large companies, and finally one that has 300 AI companies and is used for the " | ||
- | The //AI.xml// contains all the behaviors, data, and starting information for AI companies. The actions of the AI are based on the variables presented in the //AI.xml// file. All data is moved from the xml file to the save game. So any changes made to the //AI.xml// will require a save game. | + | The //AI.xml// contains all the behaviors, data, and starting information for AI companies. The actions of the AI are based on the variables presented in the //AI.xml// file. All data is moved from the xml file to the save game. Any changes made to the //AI.xml// will require a save game. |
- | Finally, one of the variables for an AI company is the Head Quarters ID, or hqID. The hqID value corresponds to the cityID value in the // | + | Finally, one of the variables for an AI company is the Head Quarters ID, or hqID. The hqID value corresponds to the cityID value in the // |
- | There are also some advanced options in the [[modtools: | + | There are also some advanced options in the [[modtools: |
+ | \\ | ||
+ | \\ | ||
===== AI Variables ===== | ===== AI Variables ===== | ||
- | The AI has lots of variables stored in the //AI.xml// files. | + | The AI has lots of variables stored in the //AI.xml// files. |
Line 59: | Line 65: | ||
|AI ID|This is a non-editable value that is used to uniquely identify an AI entry inside the game.| | |AI ID|This is a non-editable value that is used to uniquely identify an AI entry inside the game.| | ||
|Name|This is the name of the company. It's typically how you'll see companies in the game. 26 characters is consider the soft maximum. You can put more, but it may cause text formatting issues.| | |Name|This is the name of the company. It's typically how you'll see companies in the game. 26 characters is consider the soft maximum. You can put more, but it may cause text formatting issues.| | ||
- | |Owner|This is the AI ID of the AI that owns this company. If the owner is set to 0, then the company owns it self. Any other value than 0 will make this company | + | |Owner|This is the AI ID of the AI that owns this company. If the owner ID is set to the same as the company ID, then the company owns it self. Any other value a marque of the Owner ID company. The drop down to the right allows you to quickly select the ID of an existing company.| |
|Head Quarters|This value corresponds to the City ID for the City.xml file. If you have loaded a City.xml file, the cities should be in the drop down box for you to choose from. If you select a city which does not exist in the City.xml file, the AI company will experience errors which could crash the game.| | |Head Quarters|This value corresponds to the City ID for the City.xml file. If you have loaded a City.xml file, the cities should be in the drop down box for you to choose from. If you select a city which does not exist in the City.xml file, the AI company will experience errors which could crash the game.| | ||
|Founding Year|This is the year in which the AI company will appear in the game.| | |Founding Year|This is the year in which the AI company will appear in the game.| | ||
Line 144: | Line 150: | ||
|Design Export| This adjust how often an AI company is willing to license out their designs to other companies. Higher values means that they are more likely.| | |Design Export| This adjust how often an AI company is willing to license out their designs to other companies. Higher values means that they are more likely.| | ||
|Design Import| This adjust how often an AI company is willing to purchase other company' | |Design Import| This adjust how often an AI company is willing to purchase other company' | ||
+ | \\ | ||
+ | \\ | ||
===== Examples ===== | ===== Examples ===== | ||
Line 166: | Line 174: | ||
==== Opening AI File ==== | ==== Opening AI File ==== | ||
+ | |||
+ | You should open your city script file and select a logo folder before you open an AI.xml file. While it is not necessary, it will prevent any unexpected errors from occurring. | ||
+ | |||
+ | To Open an AI file, click on the Open AI List button ({{ : | ||
==== Adding New AI ==== | ==== Adding New AI ==== | ||
+ | |||
+ | To add an AI company to the list, simply fill out all the data on the left hand side and click the "Add AI" button ({{ : | ||
+ | |||
+ | AI Companies must have unique IDs (which should automatically be taken care of), unique names under 26 characters long, a HQ ID in an existing city within the City.xml files for a map, and a .dds logo file. Any failure to meet those conditions will result in ingame errors and possibly crashing, | ||
+ | |||
+ | ==== Editing Existing AI ==== | ||
+ | |||
+ | Select the AI from the list you wish to edit. Edit the data on the left. Then click the "Add AI" button ({{ : | ||
+ | |||
+ | If you're adding new logos to an AI company, please be sure you include the dds files in a zip file. See [[modtools: | ||
==== Removing AI ==== | ==== Removing AI ==== | ||
+ | |||
+ | Simply select the AI company you wish to remove from the list, then click the " | ||
+ | |||
+ | Removing an AI in the middle of the list will automatically re-ID all AI ID's above the removed company. Any AI companies owned by the removed company will now be owned by themselves. | ||
==== Saving AI File ==== | ==== Saving AI File ==== | ||
- | //After you have saved your AI.xml file. You will need to compress all of the logos into a single .zip file. There must not be any folders inside of the zip. Just place the files directly into the zip without any sub-folders. | + | Weither you're saving your work for future use, or you're ready to use it in the game, you will save the AI.xml using the same button. To save an AI.xml file, simply click the "Save AI List" button ({{ : |
+ | |||
+ | If you're saving for use in a new map or mod (or adding a new file to the map/mod), then the location where you save it will not matter. As the [[modtools: | ||
+ | |||
+ | However, if you're editing an existing map or mod AI.xml file, you must save the new AI file over the old one. | ||
+ | |||
+ | After you have saved your AI.xml file. Before using using the AI in the game, you will need to compress all of the logos into a single .zip file. If you're editing an existing map or mod, you must use the zip files already created. See [[modtools: | ||
+ | |||
+ | There must not be any folders inside of the zip file. Just place the files directly into the zip without any sub-folders. | ||
+ | |||
+ | |||
+ | ==== Testing New Logos In Game ==== | ||
+ | |||
+ | The game has a built in logo tester system. Start a new game with the mod, map, and AI.xml file you wish to test. Click safe in the Office to go to the Financial Room. Hold down ctrl and hit the " | ||
+ | |||
+ | If the game crashes, then you are most likely missing a logo or one is miss named. [[modtools: | ||
+ | |||
+ | |||
+ | |||
+ | \\ | ||
+ | \\ | ||
+ | ===== Troubleshooting ===== | ||
+ | Common things that can go wrong when editing AI files: | ||
+ | |||
+ | == Game Crashes When Checking Stocks == | ||
+ | Most likely you're missing a logo file in your Logos.zip or you miss named the logo filename in the AI editor. (Thus the filename is wrong in your AI.xml file) [[modtools: | ||
+ | |||
+ | Also be sure to test all the logos in the AI.xml file using " | ||
+ | |||
+ | == None of the Changes I Made are in the Game! == | ||
+ | Any changes to the AI require you to start a new save game before they take effect. Be sure to start a new game. If you are creating or editing a mod. Make sure you've selected the mod from the external Settings Editor. |
modtools/aieditor.txt · Last modified: 2022/02/15 18:00 by 127.0.0.1