tes5edit readme

Download TES5Edit Readme

If you can't read please download the document

Upload: josephhalim

Post on 23-Jan-2016

5 views

Category:

Documents


4 download

DESCRIPTION

asd

TRANSCRIPT

#summary TES5Edit ReadmeTES5Edit 3.0.30 EXPERIMENTAL by ElminsterAUUpdated for Skyrim by Hlp, Zilav and Sharlikran.TES5Edit is considered experimental. Make backups of your plugins and report any issues in the official Bethesda thread. If you have never used TES5Edit, Wiki Pages and basic videos are available.We only support version 1.9 of Skyrim and TES5Edit 3.0.30. Update TES5Edit and Skyrim before you post in the forum.TES5Edit Cleaning Guides:TES5Edit: http://www.creationkit.com/TES5EditTES5Edit Cleaning Guide (Fewer Details): http://www.creationkit.com/index.php?title=TES5Edit_Cleaning_Guide_-_TES5EditTES5Edit Mod Cleaning Tutorial (Detailed Instructions with Pictures): http://www.creationkit.com/TES5Edit_Mod_Cleaning_TutorialCurrent Official Threads:Plugin-cleaning-emporium (Unrelated to development of Edit): http://forums.bethsoft.com/topic/1425445-relz-tes5edit-plugin-cleaning-emporium/Official Bethesda Developmental Thread: http://forums.bethsoft.com/topic/1425445-relz-tes5edit-plugin-cleaning-emporium/YouTube Videos: http://www.youtube.com/user/Sharlikran/videos?flow=list&view=0&sort=ddRename to TES4Edit.exe to work with Oblivion.Rename to FO3Edit.exe to work with Fallout3.Rename to FNVEdit.exe to work with New Vegas.Fallout3 Training Manual for FO3Edit (applies to all game versions)http://fallout3.nexusmods.com/mods/8629Fallout NV Training Manual for FO3Edit (applies to all game versions)http://newvegas.nexusmods.com/mods/38413Check for new versions here:Nexus: http://skyrim.nexusmods.com/mods/25859/Mirror: https://code.google.com/p/skyrim-plugin-decoding-project/downloads/listImportant DirectX Information:If you get an error about d3dx9_*.dll not being installed, you need to update your DirectX to the most current version. The most current (March 2008) version can be found here: http://www.microsoft.com/en-us/download/details.aspx?id=35 DirectX End-User Runtime Web Installer or here: DirectX End-User Runtimes Redistributable (make sure to install it after unpacking it). http://www.microsoft.com/en-us/download/details.aspx?id=23611Future of TES5Edit:We appreciate all the thanks and support from the community. HuguesLePors recently volunteered and was responsible for the additional updates to the VMAD routines. Although they look good please keep backups of your plugins and report any errors with VMAD. Zilav has some updates planed that will improve the Check for Errors routine so that it includes checking for assets. The additional function will check for meshes, textures, pex scripts, seq files (if needed), and will search BSA files as well. This will help end users check to see if all required assets are present. When files are missing especially scripts, that can lead to undetected issues, malfunctions with the plugin, and CTDs.Although we welcome suggestions for improving TES5Edit automation is not one of them. We do not plan on adding an automated way to clean multiple plugins or access to TES5Edit from the command line. Currently cleaning a plugin involves indexing over a million references at times. When only the required plugins are loaded then the cleaning is accurate. If unnecessary plugins are involved those become part of the index and could cause the plugin to lose important and required data. We understand the need for unattended automation at times. However, without human intervention too many issues during the cleaning process would go unnoticed and make troubleshooting game issues related to plugins even more difficult then it already is.As TES5Edit becomes more widely used in the Skyrim community it has become a concern that many people want to use the utility in place of the Construction Kit. This is still not recommended. We work hard to make TES5Edit as accurate as possible but development is directly related to the plugins themselves. TES5Edit can not replicate all the changes that the CK will make. Attack Data is the best example. Merely checking or unchecking certain things for an NPC will alter the attack data dramatically. We won't be adding those types of things to TES5Edit. Please understand that we don't directly support the use of TES5Edit when it is used outside the scope of its design which is conflict resolution. Editing masses of entries, merging plugins, and creating compatibility patches for Skyrim overhauls may be possible. However, please create your own separate thread apart from the official Bethesda developmental thread for TES5Edit.Trouble shooting plugins:Detecting issues with plugins is a big concern. Nobody wants to start their game over due to constant crashes to desktop. Detecting issues with plugins is very difficult and is unique depending on the other plugins in your load order. Recently I had two plugins that I felt were not related to the cause of my own crash to desktop while in the character creation menu. However, after uninstalling those plugins I was able to create a new character and experience uninterrupted game play. I know many of you look to the TES5Edit development team for guidance but we are not modders. We rarely use the Construction Kit unless we need to test the data in the records of the plugins. As noted by FlaFlada (slightly revised) who posted on my YouTube channel: The main points if having issues are 1. Dirty mods. 2. Leveled list issues. 3. Improper mod placement. The solutions are 1.Clean all mods except Skyrim.esm and Unofficial patches using TES5Edit. 2. Let BOSS sort your mods. 3. make a bashed patch using Wrye Bash. And in this order: Update mods, activate plugins, BOSS sort mods, clean mods, create patches with TES5Edit, delete duplicate records in any user created patches already handled by Wrye Bash, drag bashed patch BELOW additional user created patches, rebuild Bash Patch. If issues persist contact mod makers.Contacting the mod authors is probably the last thing you should do after encountering an issue. Unfortunately it's the first thing most people do. As authors of TES5Edit we understand that there may be a lot of information to absorb for new users but give it time. It took us time to inform ourselves about everything so you can't expect to understand it in a day. I myself still look to the community and modders for advice and information to make sure I provide the most accurate guidance and information. Telling us or a mod author that you can't read walls of text you can't comprehend doesn't help you at all when asking for help. Most authors don't have the time to compile compatibility lists of plugins and list in detail how to manage your load order. Questions like, "Is this updated for Skyrim 1.8?", "Is this compatible with [Insert Plugin Here]?", are easily answered by reading the documentation (if provided) or reading the description page. I myself will be referring people more and more to community based resources, videos, and documentation so that I can work more directly with improving TES5Edit, updating Wrye Bash, updating plugins for Skyrim, and helping the BOSS team when possible. For that reason I will be increasingly less understanding when it comes to questions that have been asked and answered before.Previous versions such as FO3Edit, FNVEdit, TES4Edit:We understand that sometimes updates to programs break things. Please use the updates with caution. However, please use them and then report issues so we can improve the program. Our goal is to make all versions as bug free as possible and introduce new features that are useful for the modding community for all the Bethesda games this utility supports.TES5Edit Updates:With each new version of TES5Edit it is STRONGLY recommended to restore plugins from backups and reclean them. Otherwise any fixes and updates to cleaning process won't take effect. Version 3.0.30 contains the following changes:- Added Prev/NextMember for Record union. Use after adding a new one to select the apropriate.- Search for required master extended upward.- Added a second command line parameter to specify the game's ini file location. - Ctrl+A to select all in editor window.- "Jump to" option in record's header popup menu.- Enable/disable autosaves in options.- Log file is overwritten at 3MB.- [xDump] Fatal exceptions are reported through ReportProgress to have a timestamp. It might be useful to track down the issue.- [TES5] Blocks adding new script property and new scripts. Please use CK to create them.- [TES4/TES5/FO3/FNV] Record definitions update (number of ITM counts may change).Scripting:- New scripts added.- New scripting functions (including regular expressions).- New UI controls (TLabeledEdit, TCheckListBox).- Scripts can be accessed with hotkeys (Ctrl+Shift+F to call a new find cell script demo).- Removed syntax highlighter from script editor.Fixes:- Variable size detection corrected.- Out of bounds detection corrected.- Issues 125, 126, 129, 128 (128 was "worked around").Misc:- Code modified for compatibility with both Delphi XE and XE3 in the same source files.- Added BaseName property so unsorted arrays can contain structured unions.- ByteArray length increased to 64 bits. Version 3.0.29 contains the following changes:- new icon provided by moiman100 http://forums.nexusmods.com/index.php?/topic/921884-icons-for-tes5edit/- [TES5] more information is decoded (Records ARMA, NVSI, MOD2, LVLO).- [TES5] Every string value gets own ID when localizing plugin- [TES5] Fixed error when copying VMAD scripts using drag&drop- issue 104 : Files others than esp and esm (and ghost) are timestamped.- issue 88 : Delete from the view pane column title contextual menu is disabled (due to a hard to reproduce bug). This is a workaround, not a fix.- issue 119 : [TES5] The CK adds useless XLRL records when reverting a change. Those XLRL are considered benign and the record ITM.- issue 110 : Check for errors now checks for invalid FormIDs. Also, new "Check for errors" sample script.- Options are processed when they matter, not at the beginning.- issue 82 : [TES5] Capitalization fixed in text are being treated as dirty edits. Description fields are case sensitive now.Scripting:- Scripts can use other scripts with standard pascal "uses" keyword.- New functions available.- New sample scripts.Fixes:- Compare to will not overwrite an existing file, nor will it leave temporary files behind.- issue 125 : Condition added are no longer empty.- issue 121 : Changing FormID of Region causes severe bugs. Reference building is delayed to after the change is done. Non region reference XCLR record are no longer removed.- issue 120/118 : Reference not updated while adding a master. Reference lookup during the addition were sometime unreliable. - issue 117 : Bug in script Undelete and Disable References.pas - issue 112 : Option "Simple Record" malfunctioning.- issue 111 : AV when saving subrecords with prefixed arrays. Sizing and memory allocation are done properly during every phase.- issue 108 : Very slow saving after editing ESM flag. Background updating limited as much as possible during saves.- issue 107 : Copying a quest record causes extraneous script fragment data to be generated. Sizing and memory allocation issue.- issue 106 : Error adding a new master to plugin with own navmeshes. Fire Union decider when they can effectivly properly work, not before.- issue 105 : Overwriting quest fragments or Quest Aliases may produce exceptions. During copy, memory is initialized properly before being used.- issue 100 : Voice Type EditorID disappears. Memory sizing issue.Known issue:- issue 123 : Using Check for errors after sort master, before saving and reloading: the Cell formID will not be updated. (that is a display issue only).- issue 102 : Objects with property names but no assigned values don't display the names. The CK does not save the property name in the plugin in that case so it is correct.Misc:- issue 115 : "Backup plugin" checkbox anchored to bottom of form.- avoid firing some catched exception (to ease debugging).Version 3.0.28 contains the following changes:- With this version it is important to clean all of your plugins after restoring the original Nexus or Steam workshop files. (Don't ask about this in the forum)- [TES5] Papyrus (VMAD subrecord) support and other misc record updates including Dragonborn DLC- [TES5] "Next Object ID" error when copying records- Text fields in records are case sensitive when matching- Ability to change references to FormID < 800h- Changeable conflict colors and default column width in options- "Simple records" option for concise displaying of LAND, NAVM and NAVI records (excluding references). On by default to speed up xEdit, customizable in options- Improved scripting functions, new demo scriptsVersion 3.0.27 contains the following changes:- [TES5] Updated dialog subtypes for patch 1.8- Localize/delocalize utf8 strings. Translation is disabled, highly recommended to use StrEdit or other specialized tools instead- Search by FormID/EditorID skips hidden elementsVersion 3.0.26 contains the following changes:- [TES5] BODT is unchanged (troubles with Dawnguard.esm)- [TES5] Fixed bug in RACE with sorted biped object names. If you modified race records with previous versions, drag&drop biped object names from master to restore them.- Additional internal functions accessible from scripts (new demo scripts)Version 3.0.25 contains the following changes:- [TES5] Impact data set IPDS is now sorted- [TES5] Added DEST data to ALCH (for "Destructible bottles")- [TES5] BODT subrecord is autoreplaced with BOD2 in ARMA, ARMO and RACE records to conform CK 1.8 format- [TES5] Additional decoding in WRLD and RACE for new data saved with CK 1.8- [TES5] Added back records to Merged Patch (removed in 3.0.24) but only when the winning record has no scripts- [FNV] Updated missing INFO flags- [TES4] Fixed error when copying SPEL record- Pascal-based scripting system and "Apply Script" menu (check available demo scripts on how to)- "Options" menu- "Analyze Log" menu, currently supports * Skyrim papyrus log * Oblivion RuntimeScriptProfiler log http://www.oblivion.nexusmods.com/mods/41863- Moved several not so often used menus to the "Other" submenu (Build ref/reachable, Merged Parch, Seq File, Localization, etc.)- Full expand key modifier changed to ALTVersion 3.0.24 contains the following changes:- [TES5] Updated load order handling when plugins.txt is empty and no BOSS info is available- [TES5] Fixed event name definition in QUST- [TES5] CELL water level fixup for better conflicts detection- [TES5] Autoremoving legacy RNAMs from WRLD; empty keywords from NPC_, ARMO, AMMO, WEAP, ALCH, MISC- [TES5] Removed NPC_, ARMO, AMMO, WEAP records from Merged Patch (unsafe to copy possible scripts to a new plugin)- [FO3] No sorting of DIAL groups- [FO3/FNV] Fixed record definition for ragdolls which crashed game after cleaning several DLCs- Copy "Compare to" selected file to the game's data folder if it is not there- Improved registry handling on x64 systems- Hold CTRL key when expanding a node for full expandVersion 3.0.23 contains the following changes:- [TES5] Merged patch updated for Skyrim, currently it merges: * Leveled NPCs, Items, Spells * NPC: Items, Spells, Head Parts, Factions * Race: Hairs, Eyes, Spells * Containers * Relations * Form Lists * Keywords on: Armor, Weapon, Ammo, NPC- [TES5/FNV/FO3] When performing UDR there will be a warning message for deleted NavMeshes.- [TES5] Updated record definitions. * BPDT was sorted by a localized name which is inconsistent for different languages (now sorted by a node name) * NPC's tints are now sorted by tint index for better conflicts detection * QUST aliases are no longer sorted by index * QUST stages are now sorted by stage index * Improved NavMeshes (thanks to Divstator)- [TES5] FaceFX phonemes where empty after copying RACE record.- [TES5] Fixed bugs when copying RACE and QUST (empty model was created for RACE; QUST location aliases were turning into ref ones).- [TES5] Create start-enabled quests sequence SEQ file (you can select several files at once).- [TES5] Improved error checking.- [FNV] CHAL record was missing some challenge types from Dead Money DLC.- [FNV] Disabled DIAL sorting, was causing errors when copying INFO records.- No autosaves when "you know what you are doing".- Compare with external tool option in Edit window.- "Apply Filter for Cleaning" menu. Note that xEdit saves filter settings when you press OK button in filter window, so if you clean plugin and exit the program, your filter settings will be preserved.- Filter option for deleted records.- Saving messages to [TES5/FNV/FO3/TES4]Edit_log.txt upon exit.- Fixed minor bug when Edit can't find game's folder. If your registry settings is invalid due to a Steam bug and Edit is unable to find your game, put it in the game's root folder where the game executable file is (Oblivion.exe, TESV.exe, etc). Version 3.0.22 contains the following changes:- Skyrim Support.- New exceptions handler.- Optional backups in a separate directory.- Remember position and state of the main window.- Fixed bug when editing with Shift+DblClick.- [All] Wrye Bash ghosted plugins (*.esp.ghost) in plugin selection window.- [ALL] FLST form list is no longer sorted.- [ALL] EDID affects conflict detection.- [TES5] Localization editor, plugin localization/delocalization with optional translation.- [TES5] -l:language command line switch to chose default localization files.- [TES5] Adding missed plugin files from plugins.txt/loadorder.txt to the end of plugins list.- [FNV] WeaponModKit IMOD record support for various subrecords.- [FNV] PLD2 subrecord is no longer removed in package.- [FNV/FO3] Quest stage signed value overflow fix.- [Oblivion] Fixed ownership record order in CELL.- [Oblivion] Snowy weather definition fix (thanks to Arthmoor).Version 3.0.19 contains improves record definitions to handle DeadMoney.esm betterVersion 3.0.15 contains the following changes:- double click on a FormID in the message view while holding CTRL jumps to that record- fixed crash when changing perk effect type to Entry Point- Quest Stage field for Quest + Stage Perk Effect Type now has a drop down with all stages available for the selected quest- single click on an already selected field now opens the editor again- fixed in-place editor to properly cover the complete field and have it's text align exactly with the text normally displayed- MasterUpdate and MasterRestore modes are supported (Warning: highly experimental, handle with care)Version 3.0.16 contains the following changes:- FalloutNV.esm not marked as modified if duplicated groups have been merged- fixed crash when looking at base effect records- "unsaved changes" dialog should no longer appear if detail view is in edit modeVersion 3.0.13 syncs up the engine with the most current version of TES4Edit, TES4LODGen and FNVEdit.Version 3.0.15 contains the following changes:- double click on a FormID in the message view while holding CTRL jumps to that record- fixed crash when changing perk effect type to Entry Point- Quest Stage field for Quest + Stage Perk Effect Type now has a drop down with all stages available for the selected quest- single click on an already selected field now opens the editor again- fixed in-place editor to properly cover the complete field and have it's text align exactly with the text normally displayedWhat's new in Version 2.5.3?Fixes assert error when copying certain subrecords.What's new in Version 2.5.1?Bug Fix: floating point comparison is now less "fuzzy". This can result in some floating point numbers now comparing as unequal even though they are within the limit of the accuracy of single (4 byte) floating point values. But it will prevent cases where floats that should be unequal compared as equal.What's new in Version 2.5.0?Context menu on file node in navigation treeview -> Renumber FormIDs from...Renumber FormIDs from will change all FormIDs of records belonging to that file (but not any override records which might be contained in that file) so that they start at the specified value.This is useful if you have multiple modules that you plan to update in the future, but also want to always provide a merged version (e.g. using FO3Plugin). By assigning non overlapping FormIDs to the different modules, you can make sure that no FormID reassignment of conflicting FormIDs has to take place when merging.WARNING: changing the FormIDs of an existing module will make it savegame incompatible and will break any other module that uses this module as master. If you have any dependant modules, you need to have them all loaded into FO3Edit at the time you change to FormIDs so that they will all be updated accordingly.Also, this version has been compiled with the "large address aware" flag and will be able to use up to 4GB when running under a 64bit version of Windows.What's new in 2.3.0 EXPERIMENTAL?large number of small fixes to record definition, resulting in many more cases of records correctly identified as "identical to master" and a very significant reduction in potential false positives in the "Check for Errors" function.on the fly conversion of outdated records to the most current format. This means that you will see fields show up as modified that you didn't modify yourself (mainly in Oblivion.esm, CS created files should already be up to date). It is possible to disable this function by starting FO3Edit with -nofixup as parameter. It is also possible to just these modifications (but still keep the fixups) by starting TES4Edit with -hidefixup as paramter. This function replaces the -fixupPGRD from earlier versionsNew function to copy idle animations:Bugfix to prevent dialog choices from being sorted by FormIDThe Undelete and Disable function will set the Player ACHR [00000014] as Enable Parent with the "Set Enable State to Opposite of Parent" flag set. Given that the player should never end up being disabled, that should properly remove them from the gameworld, even if they are persistent references and the enabled state has already been stored in the savegame.The Undelete and Disable function will also now properly list all affected references, just like the "Remove 'Identical to Master' Record" function does.The selection dialog now allows double clicking an entry, this will automatically select that entry, deselect all others and close the dialog as if the OK button had been pressed.What's new in 2.2.3?Game Settings (GMST) will now be properly resolved based on EditorID, not FormID.A field in the Region record was improperly defined as a Float field.What's new in 2.2.0?This version contains no major new functionality, but a number of bugfixes. Update is highly recommended. TES4View is an advanced graphical esp viewer and conflict detector.When started it will automatically find your Oblivion Data directory. You then get a dialog to select which masters/plugins you want to load with the current selection from your plugins.txt as default value. This is followed by a second dialog which lets you choose which records not to load. By default this is LAND, PGRD, ROAD and REGN because these records are very large and usually not very interesting to look at. Once you have confirmed that dialog the selected plugins will start loading them in the background. Depending on your system it should take 30 seconds to a few minutes (!) for all plugins to load. You can follow the progress in the message window. (Don't panic if it seems to freeze, it just takes time).The tree view on the left side now shows all active masters and plugins in their correct load order. By navigating that tree view you can look at every single record in any of your masters or plugins.Once a record has been selected the detailed contents of that record is shown on the right side. The detail view shows all versions of the selected record from all plugins which contain it. The left most column is the master. The right most column is the plugin that "wins". This is the version of the record that Oblivion sees.Both the detail view and the record list use the same color coding to signal the conflict state of individual fields (in the detail view) and the record overall (in the record list). Background color:White - Single RecordGreen - Multiple but no conflictYellow - Override without conflict');Red - ConflictText color:Black - Single RecordGray - Hidden by Mod GroupPurple - MasterGray - Identical to MasterOrange - Identical to Master but conflict WinnerGreen - Override without conflictOrange - Conflict winnerRed - Conflict loserConflict detection is not simply based on the existence of multiple records for the same FormID in different plugins but instead performs a comparison of the parsed subrecord data.The record tree view on the left side has a context menu where you can activate filtering. Filtering is based on the same conflict categorization as the background and text color.Yes, filtering will take a while. It has to decode and compare the contents of every single record which turns up more then once. What's new in 1.1?- Game Settings are handled correctly now- Function Type and Params in Conditions are decoded completely- Mod Groups (more about that later)- Settings (records to skip, mod groups, filter) are loaded/saved into a .tes4viewsettings file with the same path and name as the plugins.txt (or the plugin list passed on the command line)- Possible range check error when loading a file with errors should be goneWhat are Mod Groups?The answer to the "I installed FCOM and everything is red! What do I do now?" question. There are groups of mods that, while raising heaps of conflict warnings, should be considered as non-conflicting. e.g. if you've installed FCOM then you are not interested in seeing conflicts between the mods that make up FCOM. The solution for this is to define a mod group. Mod groups are stored in a TES4View.modgroups file in the same directory as TES4View.exe. There already is such a file included with a few example mod groups defined. This is just an example and not meant as a guarantee that these specific mod groups are "clean" and conflicts can safely be ignored. Not all mod groups defined in that file will necessarily show up in the selection list. Mod groups for which less then 2 plugins are currently active are filtered. If the load order of plugins doesn't match the order in the mod group it is also filtered.What's the effect of having a mod group active?When the detail view for a record is generated and multiple files of the same mod group modify this record, then only the newest of the files in that modgroup will be shown. So instead of seeing 5 different files with numerous conflicts you are only seeing the newest file in that mod group. This also affects conflict classification.It's worth pointing out here that if a record is overriden by both plugins in a mod group and other plugins that normal conflict detection will still work perfectly.Basically this system can be used to reduce a lot of noise from the conflict reports.What's new in 1.2?- Filtering the first time should be noticable faster- Filtering a 2nd time should be over almost instantly- New conflict category "Hidden by Mod Group" which can be filtered on- When sorting by EditorID or Name the files get sorted by filename instead of load order- Improved parsing of Path Grids- A lot of "unknown" fields and flag values now have a proper name- Selection dialog (used for files, record to skip, mod groups, ..) has a context menu with "Select all", "Select None" and "Invert Selection"- added a couple more mod groups for the official plugins- Bugfix: Filtering could wrongly filter out records with conflicts if their parent is also a record (not a group) and didn't contain a conflict- numerous tweaks to the mechanism which assigns conflict classifications- When filtering it is possible to "Build reference information" (adds quite a bit of additional processing time). After this has been done a new tab "Referenced By" is available if the currently selected record is referenced by any other records.- Mod groups are applied better under certain circumstances.- double clicking on a row in the right side treeview will open a window that shows the text of that field in a multi line memo. So you can now easily read scripts or books- everything I've forgotton about ;)Forum: http://forums.bethsoft.com/topic/1418088-relz-tes5edit/ Be warned, this program uses a lot of memory. Performance on a system with less then 2GB of RAM will most likely be sub-optimal. Activating the filtering uses even more memory.TES5Edit also has a little brother: TES5Dumphttp://code.google.com/p/skyrim-plugin-decoding-project/downloads/listIt's based on the same parsing engine and converts any given esp or esm into a text representation. (No conflict detection or funky colors here tho I'm afraid).