modtools:playerlogoeditor
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
modtools:playerlogoeditor [2017/05/10 11:58] – admin | modtools:playerlogoeditor [2022/02/15 18:00] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Player Logo Editor ===== | + | ====== Player Logo Editor |
Line 6: | Line 6: | ||
All logo files must be 256x128 resolution and in DDS format using DTX1, DTX5, or A8R8G8B8 compression. See [[Artwork: | All logo files must be 256x128 resolution and in DDS format using DTX1, DTX5, or A8R8G8B8 compression. See [[Artwork: | ||
- | {{ : | ||
- | === Mod Tools === | + | |
+ | \\ | ||
+ | \\ | ||
+ | \\ | ||
+ | \\ | ||
+ | {{ : | ||
+ | ===== Mod Tools ===== | ||
To access the Player Logo Editor, you must open the Mod Tools. See [[ModTools: | To access the Player Logo Editor, you must open the Mod Tools. See [[ModTools: | ||
Line 21: | Line 26: | ||
\\ | \\ | ||
\\ | \\ | ||
- | === Files and How it Works === | + | ===== Files and How it Works ===== |
Logo information is stored in an XML file named // | Logo information is stored in an XML file named // | ||
Line 28: | Line 32: | ||
Each entry in the // | Each entry in the // | ||
- | The game reads DDS files from zip files. However the | + | 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. | ||
Line 35: | Line 40: | ||
- | === The Editor === | + | |
+ | ===== The Editor | ||
Line 41: | Line 47: | ||
{{ : | {{ : | ||
- | 1) Creates a New | + | - |
+ | - 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. | ||
+ | - Saves the information in the #6 list to a PlayerLogo.xml file. | ||
+ | - Returns to the Previous Editor or Main Menu. | ||
+ | - Opens Aorta, the DDS Converter Program //(Windows and OSX)//. | ||
+ | - 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' | ||
+ | - 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. | ||
+ | - This is the name of the logo. This will appear in the game from the drop down lists where you select the logos. | ||
+ | - 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. | ||
+ | - This adds the logo information on the right to the list on the left. | ||
+ | - 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. // | ||
+ | |||
+ | |||
+ | - Open the Mod Tools and Player Logo Editor | ||
+ | - Click "Open Logo File", navigate to the media/ | ||
+ | - Open the // | ||
+ | - Open the / | ||
+ | - Extract the contents of Logos.zip into this or another folder. | ||
+ | - Add the new DDS files to the same folder | ||
+ | - Next click the Logo File Folder selector " | ||
+ | - Navigate to the folder with your logo DDS files, and select that folder. | ||
+ | |||
+ | === Adding New Logos === | ||
+ | |||
+ | - Write the name of the logo as you wish it to appear in the game in ( {{: | ||
+ | - Select the logo file you wish to use ({{: | ||
+ | - Finally click //Add Logo// ({{: | ||
+ | |||
+ | === Removing Logos === | ||
+ | - Click the logo on the left from the list ({{: | ||
+ | - Click //Remove Logo// ({{: | ||
+ | |||
+ | === Saving Changes === | ||
+ | - Click //Save Logo File// ({{: | ||
+ | - Save over top of the // | ||
+ | - Navigate your file explorer to your / | ||
+ | - 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**, | ||
+ | ==== 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 // | ||
+ | |||
+ | If you wish to create a // | ||
+ | |||
+ | === Saving PlayerLogos.xml Mod File === | ||
+ | |||
+ | == Modifying an Existing Mod == | ||
+ | - Overwrite the // | ||
+ | - Add the new .DDS files to either mod_MODNAME_MiscArtwork.zip, | ||
+ | |||
+ | == Creating A New Mod == | ||
+ | |||
+ | If you are creating a new mod, then you just need to save the // | ||
+ | |||
+ | You will then select these items when using the [[ModTools: | ||
+ | |||
+ | When you export the finished mod, all files that you checked off in the [[ModTools: | ||
+ | |||
+ | ===== 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. [[modtools: | ||
+ | |||
+ | == Game Crashes When I Select A Logo == | ||
+ | Most likely that specific logo filename is incorrect or missing. First [[modtools: | ||
+ | |||
+ | == None of the Logos I made Are There == | ||
+ | If you saved them to a Mod File, then be sure you've [[gamemanual:: | ||
+ | |||
+ | 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: 2022/02/15 18:00 by 127.0.0.1