User Tools

Site Tools


modtools:playerlogoeditor

Player Logo Editor

The Player Logo Editor allows you to add your own logos to the game. You can then use these logos at the start of the game and any time you make a marque.

All logo files must be 256×128 resolution and in DDS format using DTX1, DTX5, or A8R8G8B8 compression. See How to Create a DDS for more information on DDS creation.





Mod Tools

To access the Player Logo Editor, you must open the Mod Tools. See How to Open the Mod Tools if you do not know how to access the Mod Tools.

The Player Logo Editor is available on the right hand column of the Mod Tool's Main Menu. Click the button circled in the following image, labled “Player Logo Editor.”







Files and How it Works

Logo information is stored in an XML file named PlayerLogos.xml. The XML file can be overridden via a mod file. If a mod file does not override the XML file, or if the default game files are being used then it will use the file located in the default media/scripts folder of the game. See: File Locations for more information about where the files are located.

Each entry in the PlayerLogos.xml file must have a unique name and the file name of a DDS file.

The game reads DDS files from zip files. However the the Player Logo Editor (and all the Mod Tools) can not read DDS files from zip files. As such, you need to put all the logos you want into a folder for the Player Logo Editor to read. Then when you are ready to use the logos in the game, you need to put all the logo DDS files directly into either the Miscellaneous Artwork zip for your mod, or the Logos.zip file in the default Logos folder for the game if you are not making a mod.

Please Note, do not put the entire folder in the zip file. Just put individual files into a single zip file. The game can not read inside of folders that are inside of .zip files.

The Editor

The editor consists of lists, buttons, and text boxes. Let's walk you through what each does.

  1. Creates a New Player Logo List, IE it clears out all data you have entered or loaded.
  2. Open an existing Player Logo List from the default files or a Mod File. Please note, you must still select a folder with your logo images in them.
  3. Saves the information in the #6 list to a PlayerLogo.xml file.
  4. Returns to the Previous Editor or Main Menu.
  5. Opens Aorta, the DDS Converter Program (Windows and OSX).
  6. This is a list of the existing logos saved in the Editor, whether you opened them from a file or created them from scratch. Please note, this does necessarily mean they're saved to disc, you must use #3 to save to disc. Selecting an item in this list will automatically fill the content on the right with its data.
  7. This is where you'll select a folder which contains all the DDS images of the logos you wish to add or edit in the game/mod.
  8. This is the name of the logo. This will appear in the game from the drop down lists where you select the logos.
  9. This is file name of the logo you are adding. The drop down box is filled with the files located in the selected logo files folder in #7.
  10. This adds the logo information on the right to the list on the left.
  11. This removes the selected logo on the left from the list.

Walkthroughs

There are two ways to implement your own logos. The most straight forward way is to edit the core game files. Do not do this if you plan to distribute your changes. Any updates to the game will erase your changes.

The other way is through the mod file system. This is a little more work, but it allows you to easily share the files and it won't be erased with any updates to the game.

Editing Core Files

Only edit core game files if you do not intend to distribute them. Updates to the game may erase any changes to these files, and errors may cause the game to not work. If you break your install, please verify your game cache, or reinstall the files (remember to back up before editing), or reinstall the game.

  1. Open the Mod Tools and Player Logo Editor
  2. Click “Open Logo File”, navigate to the media/scripts folder. In Windows and Linux this is typically back one folder (..) then media/scripts. In OSX it would be back one folder (..) then Resources/Media/scripts. See File Locations for more information on locations.
  3. Open the PlayerLogos.xml file.
  4. Open the /media/Logos folder in your file browser. See File Locations on how to get there.
  5. Extract the contents of Logos.zip into this or another folder.
  6. Add the new DDS files to the same folder
  7. Next click the Logo File Folder selector “…” button. ( #7 in the picture).
  8. Navigate to the folder with your logo DDS files, and select that folder.

Adding New Logos

  1. Write the name of the logo as you wish it to appear in the game in ( #8 in the picture).
  2. Select the logo file you wish to use (#9 in the picture). If no logo files appear, then you did not select a folder with DDS files in it on step #5 or #7 under Editing Core Files. If the specific file you want is not there, then you did not do step #6 under Editing Core Files.
  3. Finally click Add Logo (#10 in the picture) to add the logo to the list.

Removing Logos

  1. Click the logo on the left from the list (#6 in the picture).
  2. Click Remove Logo (#11 in the picture).

Saving Changes

  1. Click Save Logo File (#3 in the picture).
  2. Save over top of the PlayerLogos.xml you in step #2 and #3 under Editing Core Files.
  3. Navigate your file explorer to your /media/logos folder as you did in step #4 under Editing Core Files.
  4. Add all the files back into Logos.zip. Or create a new Logos.zip and overwrite the previous one. Please note, some files from Logos.zip are required, so include all files from the old Logos.zip otherwise the game will crash. Also Note, do not include any folders. The game is unable to read folders inside of zip files. Please just place the files themselves into the zip file.

As a Mod File

Editing the Player Logo List as a mod file is a little more involved, however it does allow you to distribute the resulting files and protects you from having your work overwritten by a game update.

If you wish to use the default PlayerLogos.xml as a base, the directions for opening, adding, and removing logos is the same as Editing Core Files. If you wish to open a PlayerLogos.xml from an existing mod, you would follow the same directions for in Editing Core Files for opening, adding, and removing, except you would open the mod_MODNAME_PlayerLogos.xml from the /media/mods/MODNAME/scripts/ folder. Instead of the PlayerLogos.xml file found in the /media/scripts/ folder.

If you wish to create a PlayerLogos.xml file from scratch, you would just create it.

Saving PlayerLogos.xml Mod File

Modifying an Existing Mod
  1. Overwrite the mod_MODNAME_PlayerLogos.xml in the /media/mods/MODNAME/scripts/ folder.
  2. Add the new .DDS files to either mod_MODNAME_MiscArtwork.zip, mod_MODNAME_ComponentImages.zip, or mod_MODNAME_VehicleArtwork.zip. The default zip file ismod_MODNAME_MiscArtwork.zip, if it exists. If none of these zip files exist in the mod, you will have to modify the mod by using the Mod Data Editor.
Creating A New Mod

If you are creating a new mod, then you just need to save the PlayerLogos.xml into a location you remember, and add all the new artwork into one zip (including any other artwork you may need from other editors).

You will then select these items when using the Mod Data Editor.

When you export the finished mod, all files that you checked off in the Mod Data Editor will be moved to the exported folder and properly renamed.

Trouble Shooting

After editing the PlayerLogo.xml files, if something breaks:

Game Crashes On Start

Most likely you overwrote the core Logos.zip file and forgot to include the core DDS files used in the game. Files such as VentLogo.dds and GearCityMainLogo.dds are required. Check your Log Files to see which file is missing and add it to the .zip.

Most likely that specific logo filename is incorrect or missing. First Check your Log Files to see which file it says is missing. Next check your zip file containing the logos to see if it is there. If it is not, add it. If the name of the file is wrong in the log file, then it is named wrong in your PlayerLogos.xml file.

None of the Logos I made Are There

If you saved them to a Mod File, then be sure you've Loaded the Mod.

If you're trying to alter the core files, be sure that you overwrote the PlayerLogos.xml file in the script folder. It must be named exactly the same, everything is case sensitive.

modtools/playerlogoeditor.txt · Last modified: 2017/05/10 15:46 by admin