STEP:Mod Testing: Difference between revisions

From Step Mods | Change The Game
 
(299 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Guides]]
[[Category:Step Guides]]{{PageTitle|logo=delta|title=Step Guide-Mod Testing|subtitle=An in-depth manual to mod testing for Step Modifications|author=The Step Team|forumtid=271}}
{{Warning|This page is under construction!}}
{{TOC}}
{{Notice|This is a WIP! Editors are encouraged to verify content; however, refrain from adding additional content until the Guide is completed by TechAngel.}}
To ensure consistent and reliable mod testing, it's essential to minimize variations that can lead to a range of issues and inconsistencies. This guide will outline standardized techniques for mod testing that Step Modifications employs for evaluating all mods featured in our official modding guides. The recommendations provided progress through system and software setup before delving into the mod testing process.
''Mod Testing for S.T.E.P. -- by the S.T.E.P. Team''
:Updated: {{ #time: G:i:s j F Y "(UTC)" | {{REVISIONTIMESTAMP}} }}
[http://forum.step-project.com/showthread.php?tid=321 '''GUIDE FORUM THREAD''']


'''
== Understanding Mod Testing ==
= Introduction =
Mod testing encompasses various aspects. However, in the context of this guide, it refers to the assessment of mods for potential inclusion in a curated mod list. This evaluation involves several key components:
'''
# '''Stability Testing:''' assesses a mod's stability when integrated with other mods in the mod list. It aims to identify any conflicts or issues that may arise from mod interactions.
# '''Functionality Testing:''' mod functionality is scrutinized to ensure it operates as intended. Any deviations from the mod's intended purpose are noted and addressed.
# '''Mod Comparison:''' mods with similar content are compared to determine which one provides the best solution.
# '''Lore and Mandate Assessments:''' mods are evaluated against Elder Scrolls lore to ensure they align with the established lore and adhere to the Step Mandates. This ensures that the mod fits seamlessly into the Elder Scrolls universe.


==General Information==
It's important to acknowledge that mod testing can be a time-consuming and meticulous task. Nevertheless, it can also be rewarding and enjoyable. Mod testing is ideally suited for individuals who are genuinely dedicated to the process. Consequently, turnover rates among users involved in official testing are high, as many underestimate the demands of mod testing; quickly become overwhelmed by the complexity of the task.
This guide will attempt to lay out best practices for testing mods marked for testing which could be potentially included in S.T.E.P. With a guide as complex as S.T.E.P., it is beneficial to reduce as much variation as possible in mod testing, since variation can breed a host of issues. This guide will outline standardized testing techniques for S.T.E.P. mod testing. The approach will be bottom-up, meaning recommendations will begin at the hardware level, progressing to software, and then to mods.


==== Mod Testing ====
Following is described the detailed process required for testing mods in a manner that ensures consistency and facilitates recommendations (or not) for a Step Game Guide. Our aim is to maintain a process that is straightforward and efficient, yet given the complexity and extensive nature of some mods, this process may not encompass every conceivable mod testing scenario. While common scenarios are provided, it's crucial for testers to exercise best judgment when faced with situations not explicitly covered.
What is mod testing? Mod testing can be many different things; however, for the purposes of S.T.E.P., mod testing is the testing of mods for inclusion/exclusion in S.T.E.P. This includes testing a mod's stability with other mods, checking it against Elder Scroll lore to make sure the mod is lore-friendly, testing the mod's function to make sure it's working as expected, comparing it to other mods of similar content to find the best solution, and much much more. Mod Testers are the team members whom job this falls to.


Mod Testers are not unlike foot soldiers for S.T.E.P. They are the front lines in mods getting added or dropped from S.T.E.P. and similar to real soldiers, their job is often the hardest and most unglamorous on the team. Mod testing can be long and tedious at times, but it can be fun and joyful too. This is to say, mod testing is only for those that have a real dedication to it. As such, the turn around rate on Mod Testers tends to be high as Testers can quickly become "wore out" when they don't realize what they're getting themselves into. Before considering becoming a Mod Tester, read through this guide. It should give you a fairly reasonable idea of what Mod Testers do.
== System Preparation ==
Before embarking on mod testing, it is essential to establish a stable system and game installation. Without them, distinguishing whether a mod is incompatible with the mod list or the system becomes significantly more challenging. Testers should have their systems configured according to one of the Step Game Guides. Nevertheless, here are some general reminders and best practices to ensure the environment is adequately prepared for mod testing.


==== Mod Tester Requirements ====
=== General Setup ===
To be an official Mod Tester there are a few requirements that STEP will need the Testers to meet. If you can meet these requirements and are interested in becoming a Mod Tester for STEP, contact an administrator.
* Ensure the [[Guide:System_Setup_Guide|System Setup Guide]] is complete
* Ensure a clean and ''pure'' installation of the Step Game Guide for which testing is being performed
*: {{fc|instruction|A ''pure'' installation means nothing exists within the mod list that isn't included in the Game Guide; the installation should be 100% within the bounds of the Guide.}}


* Tester's computer must be able to play Skyrim with a fully installed STEP: Extended profile on medium to high settings.
=== Game Settings ===
* Testers must use a mod manager to be able to test. Mod Organizer is the official recommendation for STEP Testers.
All game INIs, launcher, and in-game settings should be configured according to the Game Guide for which testing is being performed. Therefore, any post-installation changes should be reverted back to the Guide's instructions for the duration of testing.
* Testers must be able to set aside a small amount of time every week that will be used for mod testing. Generally, ~5 hours per week should be enough; however, the more the better.
* Testers must already possess general knowledge of modding and troubleshooting to be effective.


==== Overview of Testing Procedure ====
=== Mod Organizer Profile Setup ===
''This will be updated as the procedures are developed and outlined within the other tabs. Testing is separated into two sections: external testing and in-game testing.''
Step Modifications' officially supported mod manager is Mod Organizer, and it proves itself more helpful than other managers for mod testing. Follow these instructions to set up two new profiles in Mod Organizer for testing:
# Open Mod Organizer and select the instance for the game for which testing is being performed
# Select the {{icon|moprofile|30}} icon
# Copy the Step Game Guide profile
# Name the new profile: <code>Vanilla</code>
#* Make sure the '''Local Savegames box''' is not checked for the testing profiles
#* Make sure the '''Automatic Archive Invalidation box''' is selected for the testing profiles
# Name the new profile: <code>GuideName vX.X Testing</code>
#* Make sure the '''Local Savegames box''' is not checked for the testing profiles
#* Make sure the '''Automatic Archive Invalidation box''' is selected for the testing profiles
# Select the newly created '''Vanilla''' profile and ensure no mods are enabled


* Read the thread OP and Nexus page descriptions of the mod and make pertinent notes. Note an potential conflicts with other STEP mods or issues with the mod itself.
=== Vanilla Save ===
* Read the Bethesda, Nexus, and Steam forums to develop a sense of user satisfaction and a list of possible bugs to attempt to confirm or deny.
Though playing through vanilla content may be at the top of anyone's list, this step is ''not optional''. A vanilla save point is required for some comparisons, as well as, providing a default environment from which to start the majority of testing.
* Examine the documentation of the mod, note any lack of clarity, installation and uninstallation directions, and general completeness.
# Select the '''Vanilla''' profile
* Validate the archive package, naming scheme, directory structure, and installation procedure.
# Start a new game from this Vanilla profile
* Use TES5edit to determine quality of edits in any plugin files and the scope of mod. Note any issue of not carrying over changes from the DLCs and/or from the Unofficial Patches.
# Play through any introductory quests until the first point is reached that allows for free roaming of the game
* DDSopt used to determine quality of texture compression for texture mods.
# Once at a free roaming point, save the game
* Examine files in game (to accomplish this we need to research a quick and easy way of identifying the actual name of the (texture, mesh, etc) file corresponding to what we see in game.)
#* '''Fallouts:''' play until at the starting vault's exterior
* Examine script source of mods for reliability and compatibility (if not available ask the author).
#* '''Skyrim:''' play until at the exterior of Helgen cave
* All mods with scripts must include methods for installing and uninstalling in-game or at the very least stopping scripts with a console command.
#* '''Starfield:''' play until the Frontier can be freely piloted and save at NA Spaceport
* Review Papyrus logs for script issues (if applicable).
#:: {{fc|yellow|'''''Tip:''' Use the console to create a save with a custom name for quick reference.''}} (<code>save SaveName</code>)
* Each mod is examined in multiple ways in game to confirm functionality and compatibility.
<br>
** Test in various key spots of the world using savegames.
** Test in various key points of quest development using savegames.
** Test with a Vanilla Skyrim installation. (if there are issues with the mod under this test then no further testing is needed)
** Test with a Baseline STEP installation that is complete and current (All Baseline mods installed. All mods up-to-date. No non-STEP mods installed.)
** Test with a new game and with adding it to an existing game with Baseline STEP.
** Note quality changes to the game's Appearance, Gameplay, etc.
** Note quantitative changes like VRAM, GPU, CPU, RAM, and FPS usage.
* Complete the Mod Testing wiki form and submit.
* Contact mod authors with hard evidence and constructive criticism to improve any area's in need of improvement before becoming a STEP recommended mod.


= Mod Testing Prep =
== External Testing Procedures ==
''This page has been streamlined. More or reviewed information will be added/edited.''
All testing begins outside the game. Each of the following steps should be completed and notes taken from each before proceeding to in-game testing.


===General Information===
=== Step 1 - Forum Mod Topic ===
A stable computer and Skyrim installation is crucial to testing a new mod. Without a stable computer and installation, it will much harder to determine if the mod itself is incompatible/buggy with other mods/Skyrim or if the mod is incompatible with your computer. Below you'll find some guidance on how to increase computer and installation stability, as well as how to setup your computer for mod testing.
'''Read the mod's topic opening post (OP)'''
: The mod's topic OP often contains an outline of what needs to be tested for a particular mod. Make note of this and use it when in-game testing begins. If nothing is outlined in the OP, it's likely the mod has not been tested or reviewed enough to include it. In such cases, testers will establish a outline by editing the OP. This outline should include what mod options should be tested, how to test, steps for making the mod compatible with other mods, etc. Most of this information will be gathered from the actual testing process below.


== Computer Stability ==
=== Step 2 - Nexus Page ===
: ''Reference the [[Guide:Skyrim Installation|Skyrim Installation Guide]] as needed ... this is required reading for all mod testers''. Peruse (or post questions to) the [http://forum.step-project.com/forumdisplay.php?fid=54 mod testing forum] ... guessing is not standard procedure.
'''Read the Nexus Page in its entirety'''
* '''Description:''' make note of any special installation/uninstall instructions, any known internal or mod compatibility issues, and of any potential conflicts with supported DLCs and other mods within the Step Game Guide.
* '''Posts:''' a complete read is not necessary; however, testers should attempt to develop a sense of user satisfaction. Posts can also reveal a list of possible bugs not listed within the Bugs section. Unless a mod is fully developed with few to no bugs being reported, some sort of interaction from the mod author is preferred to ensure the mod isn't abandoned.
* '''Changelog:''' changelogs often provide a sense of what direction the mod it headed, how often issues are addressed, features being edited, etc.
* '''Bugs:''' review any active bug reports. Too many bugs may disqualify a mod from being included within a Step Game Guide.


====Device Driver Updates====
=== Step 3 - Validation ===
'''Validate the archive package using MO or 7zip'''
: Observe if the downloaded archive is properly structured and configured for installation or not. For more complex installations, Mod Organizer FOMODs are preferred; however, MO can install BAIN type installations as well. FOMODs can be validated using an online validation tool, [https://www.w3schools.com/xml/xml_validator.asp XML Validator], or by using [https://www.nexusmods.com/skyrim/mods/75140 FOMOD Validator]. When installing mods using Mod Organizer, the bottom pane will also have a report of potential issues with the package.


A driver is a computer program that allows other computer programs to interact with hardware (device). Most drivers are updated relatively frequently, especially drivers for graphic devices such as AMD's or nVidia's graphic cards. Driver updates fix bugs and offer performance improvements. As such, it is quite important to have an up to date set of drivers for all your computer's hardware devices.
=== Step 4 - xEdit ===
'''Inspect plugins using xEdit'''
: Knowledge of xEdit and conflict resolution is required for this step. Load the entire Step Game Guide and the mod being tested with xEdit. Review and note any issues of the mod failing to carry forward changes from DLCs, mods, and patches included within the Step Game Guide. These notes help with creating correct conflict resolution via official patches.


If your computer is pre-built, for example, you bought an off the shelf computer under a brand (vendor) name such as HP or ACER, a program(s) is usually included that assists in vendor specific driver updates. If this is the case, it is important to use this program(s), as many brand name off-the-shelf computers have drivers specifically designed for their hardware devices, rather than generic drivers. Consult the manual or the website for information on how to do this on your computer.
=== Step 5 - Installation/Uninstall ===
* Validate installation procedure listed on the Nexus page.
* Validate uninstallation procedure listed on the Nexus page.


If your computer is custom made, then there are several excellent programs to assist with this. A great tool is [http://www.driver-soft.com/ Driver Genius], which will download an up-to-date list of drivers for almost all hardware devices, scan your computer with that list, and specify which need to be updated. The freeware version will do all of this and you can manually search for the drivers using this summary. If you upgrade to the paid version, then the program will also download and install the drivers for you. However, it is not recommended to allow this program to update your graphics drivers. This is best done manually by downloading them from AMD or nVidia.
=== Step 6 - Inspection ===
'''Inspect the installation in MO'''
# Install the mod as it will be used for testing
# Run LOOT and note information
#: Unless the mod is new on the scene, LOOT will recognize it and provide some valuable information such as if the mod is clean or dirty, requires other mods, etc.
# Using Mod Organizer, take note of any asset conflicts that appear against vanilla files and other mods in the Step Game Guide.
#: Extract any BSAs to ensure the conflicts are being read. {{fc|instruction|BSAs should not remain extracted unless required for further testing. Otherwise, remove the extracted BSA contents before continuing any testing.}}


====Overclocking====
=== Step 7 - Mandate ===
The final step is to evaluate the mod against the [[STEP:Mandate|Step Modifications Mandate]]. Ensure the mod does not fall into the "...not about" sections. If it does, no more testing is required. Post findings why the mod doesn't fit the Mandate to the mod's topic. If the mod succeeds in passes this step, continue on to the remainder of testing the mod.


If you are currently overclocking your computer it is recommended setting everything to its default/stock settings. This goes for the CPU, GPU, and RAM. Although the chances are low, it's possible for a new mod that is resource intensive to instigate stability issues, even if your previous overclock settings were stable. CPU and RAM overclocks can be managed from your motherboard's [http://www.pcstats.com/articleview.cfm?articleid=1804&page=6 BIOS], and GPU overclocks are managed by a variety of programs. A recommended program for GPU overclock management is [http://event.msi.com/vga/afterburner/index.htm MSI Afterburner].


====Junk and Unnecessary Programs====
: ''{{fs|larger|{{fc|instruction|Testers should update the mod's topic OP on the forums with any relevant information gathered from the above testing.}}}}''
<br/>


Junk and unnecessary programs can slow down and computer, eating up valuable resources. These programs include browser tool bars, shareware programs installed during the installation of a separated program, bloatware that is installed my the computer manufacturer and programs installed by the user that is not longer used or needed. Many of these programs automatically start at system boot, eating up your system resources and slowing down your computer. It's important to remove these programs for a more stable system. One great program that will help detect and remove these programs is [http://pcdecrapifier.com/ PC Decrapifier]. PC Decrapifier will scan your new or used computer for any bloatware and unnecessary programs and then run the uninstallers for these programs for you. This isn't foolproof; however, so manually scanning through your installed programs is still recommended. Remove any programs you know are no longer needed on your system; however, be careful what you uninstall if you don't know what it is. Google the program and read about it before uninstalling if the program is unknown to you.
== In-Game Testing Procedures ==
This process is the most important and will detail steps required for testing mods in a consistent way so they may be recommended (or not) for a Step Game Guide. It will be as simple and streamlined as possible, however, with the complexity, breadth, and depth that mods can be, this process will never be able to cover all mod testing scenarios. Below we provide the most common of scenarios, however, when the scenario isn't covered best-judgment must be used.


====Ghosts in the Machine====
{{AlertSmall|type=notice|text=The process for capturing comparison screenshots can be found following these procedures; which are for gameplay testing.}}<br>


Over time a computer will generate many redundant files that at the minimum will do nothing harmful, and at worst will cause stability issues. These files can include temporary files and redundant registry keys. It is recommended to use a program such as [http://www.piriform.com/CCLEANER CCleaner] to clean up these files, as well as to fix registry issues.
=== Pretesting Setup ===
'''Enable the testing profile'''<br>
Testing for Step Game Guides should be completed from the profile set up, above, for that Guide in Mod Organizer: <code>GuideName vX.X Testing</code>.


To ensure proper registry key cleaning, it is recommended to restart your computer after any program installation or uninstallation and any computer driver related changes. This is important because Windows will do some registry cleaning of its own when the computer restarts. Once you have restarted your computer, you can safely clean the registry as well as remove redundant files.
=== Step 1 - The Vanilla Experience ===
It's important to be familiar with the original content whether it be textures, quests, game mechanics, etc. Therefore, if there is no familiarity with the changes being tested, the original content should be experienced first. If familiarity does exist this step may be skipped. To complete this step:
# Load the ''Vanilla'' profile in MO, launch the game, and load the ''Vanilla'' save
# Fast travel to or use the command console to load the area closest to the mod's altered content
#: '''''Tip:''' before starting the content, make a new save that can be used later for faster testing''
# Play the game for a period of time to experience or view the vanilla content
# Close the game and review findings for the next step


====Spyware and Viruses====
=== Step 2 - Experience the Mod ===
# Relaunch Mod Organizer and select the ''Testing'' profile
# Activate the mod being tested
# Relaunch the game and load the ''Vanilla'' save or a save created for testing from Step 1
# Allow the mods to initialize
# Play the game for a period of time; assessing the mod:
#* Does it work as intended?
#* Does it look as intended?
#* Does it fit in with the game's content/ambiance/environment?
#* Are there any issues?
# Close the game and review the findings


Ensuring your system is clean of spyware and viruses is essential to a stable computer. Be sure an anti-virus is installed and working with up-to-date definitions on your system. [http://windows.microsoft.com/en-us/windows/security-essentials-download Microsoft Security Essentials] and [http://www.avast.com/ Avast] are two light-weight, respected solutions in the IT community.
=== Final Step - Review ===
# Gather the findings from all testing sources including the External testing.
# Summarize a review and post this on the mod's topic on the Step Forums. Content to include are, but not limited to:  
#* Issues with file structure and installation
#* Conflicts with vanilla or guide content (and solutions, if any)
#* Whether the mod met or fell below expectations
#* Any in-game issues
#* Personal assessment of whether the mod should or shouldn't be included in a Step Game Guide


You should also ensure your system is clean and free of any possible spyware. One of the best programs for this is [http://www.superantispyware.com/ SUPERAntiSpyware]. This program comes in several different versions, including a portable version. SUPERAntiSpyware will scan for any potential spyware issues and clean them from your system for you. It's not recommended to run this in the background consistently as your anti-virus program would. Simply run it once a month along with your regular monthly maintenance.
{{alert|type=notice|text='''Be mindful to remain objective.''' Do not write anything that will reflect upon the mod's author in a personal manner. Only review the craftsmanship, reliability, operation, etc of a mod, itself. Mods are assessed for guide inclusion, ''not'' for judgment against authors!}}
<br/>


As always with spyware and viruses, the best solution is prevention by following common best practices.
== Capturing Comparison Sets ==
When testing mesh and/or texture based mods, comparison screenshots are required and are to be posted for the community to review. These shots are not for the staff to use for evaluation, since in-game testing should be completed, but rather they are for the community's benefit and staff reference.


====Disk Fragmentation====
Screenshots and videos are provided them from in-game sources. {{fc|instruction|Do not use "studio" or "editor" applications!}} In-game lighting conditions and rendering can change the appearance of many game assets; therefore, it's important to capture these comparisons from within the game, itself. Any capture software may be used as long as the saved image is a 1:1 match in color and quality to the in-game image. Some recommendations can be found within the [[#External_Tools|External Tools]] header below.


On hard disk drives (HDD), over time files that are regularly used by the computer will fragment (located on separate parts of the disk). This increases read times and potentially causes stability issues. Defragmenting alines fragmented files by placing them in order on the disks. It is always good practice to make sure the computers HDDs are defragmented before testing a mod. Thus, defrag your computer after installing a new mod, especially large mods such as texture overhauls. A recommended program is [http://www.auslogics.com/en/software/disk-defrag/ Auslogics Disk Defrag], which allows full drive defragmenting as well as specific file and folder defragmenting.
{{Alert|type=Warning|text='''Do not''' use PNG as the file format when posting compares on the forums. They tend to be large files, which in turn cause long loading times on pages. JPG/JPEG should be sufficient and is about one quarter the payload of PNGs. Only use PNG when transparency is required.}}


If you use a solid state drive (SSD), please disregard the defragmentation advice detailed above. Defragmenting a SSD offers no benefit and will significantly decrease the life span of the drive.
=== Capture Procedure ===
Comparison shots and videos need to include:
# Vanilla reference
# current Guide reference
# mod reference
This process will allow captures to be of the exact same reference point, in each capture, with the only difference being asset replacements.
# Active a HUD mod that auto-hides the HUD for all MO profiles, including Vanilla (i.e, for Skyrim active Immersive HUD). This will auto-hide the HUD so that it doesn't have to be done manually from the console. If the Game Guide doesn't include one of these mods, the HUD will have to be manually hidden or remain present in the captures.
# Load the '''Vanilla''' profile and '''Vanilla''' save file
#: ''The mod being tested should '''only''' be active in the Testing profile.''
# While in-game, locate the vanilla reference(s) that need to be captured.
# Once the reference is found, line the capture up in the frame
#* ''Pay attention to lighting and angles to make sure the capture will be good for compares.''
#* ''Ensure nothing will interfere in the shot such as an NPC walking into the frame.''
# Once the capture is lined up, create a new save
# Now load the save that was just created
#: {{fc|warning|'''''Do NOT touch the mouse!''' Doing so may cause the capture to because misaligned.''}}
# Once loaded, ensure there is no temporary text on the screen and the HUD has been hidden
#: ''Manually hide the HUD (see [[#Helpful_Console_Commands|commands below]]) or simply leave it in the capture when no mod exists for auto-hide.''
# Take the capture using the hot key for the capture software being used
# Exit the game
# Switch to the '''Game Guide''' profile
# Repeat steps 6-9 above for the Guide captures
# Switch to the '''Testing''' profile
# Active the mod being tested and ensure its conflict resolution is as desired
# Repeat steps 6-9 above for the mod captures


====Background Processes====
=== Posting Captures ===
Post the comparison capture(s) on the Step Forums. Repeat this process for all assets that require a comparison set for any given mod. When only one asset is being tested, it is encouraged to provide several captures from various angles/locations/lighting situations for a more complete review.


Background processes will take up resources, also potentially introducing stability issues when playing or testing Skyrim. A great program for eliminating as many of these background processes as possible is [http://www.razerzone.com/gamebooster Game Booster]. This will close unnecessary programs and background programs and services. Game Booster is optimized towards gaming so it does this very well and will restore your programs and services once you're done gaming.
When posting captures on the Step Forums:
* Please use the Editor buttons/functions on the forums to post.
* Use a 3rd party service to host captures. '''{{fc|warning|Do not store your captures on the Step Wiki!}}'''
** [https://imgur.com/ Imgur] and [https://postimg.org/ Postimage] have proven to be an excellent, free image hosting sites for uploading screen captures to.
** Use [https://youtube.com/| YouTube] for hosting video captures.
**: ''Other services have proven themselves annoying for community members to use; most requiring an account to view the videos.''
<br/>


====TESV.exe Properties====
{{Alert|type=notice|text=The remainder of the guide contains helpful console commands, tips, tools, and more.}}
<br/>


These settings will ensure that when Skyrim runs, Windows Aero Theme will be disabled, freeing up VRAM, since Aero may use between [http://en.wikipedia.org/wiki/Windows_Aero 64 to 128MB] of VRAM. To access these settings navigate to your skyrim folder, right click on TESV.exe, and then click on the Compatibility tab. Tick the Disable Visual Themes and Disable Desktop Composition boxes, as shown in the image below. This only applies to Windows Vista and Windows 7; Windows 8 users will not have these options due to the requirements of the new Start Screen.
== Helpful Console Commands ==
Provided is a list of helpful console commands to use while testing. ''They are specific to Bethesda games.''<br>
To open the in-game console press the <kbd>~</kbd> (tilde) key, which is normally located just below the <kbd>Esc</kbd> (escape/exit) key on a standard keyboard. Press it again to close the console.


[[File:Recommended Settings.png|250px|thumb:'''Figure 1.''' TESV.exe Properties Settings]]
===Toggles===
<br>&nbsp;
* '''tmm 1'''
<br>&nbsp;
*: Toggles all map markers on; thus allowing fast travel to any location. Enter '''0''' in place of '''1''', to reset to default.  
* '''tgm'''
*: Toggles God Mode on/off. While in God Mode the PC will be invincible with unlimited health, magicka, and stamina.
* '''tcl'''
*:Toggles collisions on/off; thus allowing the PC to walk through anything.
* '''tfc'''
*:Toggles Free Camera Mode on/off. '''tfc 1''' will pause the camera.
* '''tm'''
*: Toggles menus on/off. Useful when taking captures.
* '''tai'''
*: Toggles all NPC AI on/off. NPC will typically not move when toggled off.
* '''tcai'''
*: Toggles all NPC Combat AI on/off. NPCs will interact normally, but will not actively attack the player.


== Skyrim Stability and Settings ==
===Player Commands===
: ''Reference the [[Guide:Skyrim Installation|Skyrim Installation Guide]] as needed ... this is required reading for all mod testers''. Peruse (or post questions to) the [http://forum.step-project.com/forumdisplay.php?fid=54 mod testing forum] ... guessing is not standard procedure.
* '''player.additem formID ###'''
*: Adds the item to the player's inventory.
*: Replace '''formID''' with the baseID of the item. These IDs can be found [https://www.skyrimsearch.com/items.php here]. Replace the '''###''' with the number of items to add.
*: For example, to add gold in Skyrim: '''player.additem f 200'''
*:: '''''Tip:''' leading zeroes can be dropped from IDs. So '''0000000f''' becomes just '''f'''.''  
* '''player.addspell formID'''
*: Adds a specified spell to the player's spell list. Spell IDs can be found [https://www.skyrimsearch.com/magic.php here].


====Launcher Settings====
===Targeted Commands===
Targeted commands require the reference to be selected in the console. To target a reference, use the mouse to click on it while the console is open.
* '''disable'''
*: Disables a targeted, enabled reference.
* '''enable'''
*: Enables a targeted, disabled reference.
* '''Kill'''
*: Kills a targeted NPC.
* '''Resurrect'''
*: Resurrects a dead NPC.
* '''unlock'''
*: Unlocks a targeted object (doors, chests, etc).


<p>Unless you're intimately familiar with the game settings and INIs, it is recommended to leave the launcher settings at their defaults. However, you may change them to your liking as long as you maintain a stable game. If you decide to change settings, keep the following in mind.</p>
===Other Commands===
Try to select a screen resolution of, or as close to, 1920x1080 as possible. This will provide a true high definition (HD) testing environment. However, if you're unable to do so, don't worry. Full HD (1920x1080) users are by no means a large majority. The other common screen resolution to test at is 1600x900; which is still 720p HD. AA should be set to at least 4x and AF to at least 8x. These can be set in the video drivers if preferred. All view distances should be at least 50% with being maxed out preferred. Distant object detail should be high or medium, at the lowest, and FXAA should be disabled (unchecked).
* '''coc locationName'''
*: Transports the player to a specified location. Replace '''locationName''' with the name of the location.
*: A list of Skyrim location names can be found [https://www.skyrimsearch.com/cells.php here] and [https://elderscrolls.wikia.com/wiki/Console_Commands_%28Skyrim%29/Locations here].
*: '''coc qasmoke''' is Skyrim's developer testing hall with containers for all game items.
* '''killall'''
*: Kills all non-essential NPCs within the player's vicinity.
* '''set timescale to ##'''
*: Changes the timescale of the game.
*: Change '''##''' to the desired value. '''20''' is default. ''Setting below '''10''' may cause issues.''


====INI Settings====
== External Tools ==
=== Capture Software ===
Feel free to use the preferred program for captures. Some 3rd party software used by the staff include:
* [https://fpsmon.com/ FPS Monitor]
* [https://fraps.com/ FRAPS] - doesn't play well with some Windows features


It is recommended to test a mod on default medium or high INI settings, and once verified, then a test on ultra settings can be done. Testing on ultra may skew the results of the testing, especially if others may want to use the mod. The majority of Skyrim users will not have high end computer setups which are able to run on ultra settings.
==== Screen Captures ====
The preferred format for screen captures is PNG due to its lossless nature. JPEG can be used as an alternative and is recommended for large comparison sets to reduce page loads. Do '''''not''''' use GIF format for screen captures! The simple solution for screen captures for some games will be to utilize their own built-in capture feature:
* '''Skyrim:''' use BethINI to set the capture path and use the <kbd>PrtSc</kbd> (print screen) key
* '''Fallout 4:''' hotkey the photo mode capture key


The easiest way to achieve this is to use a mod manager's INI functions. Make sure you generate a default Skyrim.ini and SkyrimPrefs.ini. This can be done by deleting your current INIs (remember to back them up first) in your Documents folder. Once deleted, generate new INIs by changing your settings to either medium, high or ultra in the Skyrim Launcher, as mentioned above in the Launcher Settings section. Once these default INIs have been generated, back them up.
==== Video Captures ====
The preferred formats (containers) for video captures are AVI, MKV, or MP4. Using one of these formats or a higher quality one is important for proper video captures in high definition. Capture in at least 1080p for fullHD, but ''always'' in a 16:9 format. Also use the following information for encoding:
* Use '''H.264 codec'''; MPEG-4 as a second option
* '''Audio:''' no less than a 48khz sample rate and no less than a 128kbps bit rate (96khz sample/384kbps bit rate is recommended for true HD audio)


'''Mod Organizer Users''' (recommended)<br/>
===Texture Viewers===
Using MO, the INI edits are specific to the profile that is loaded. To make a medium or high default INI, simply create a profile and copy and paste the default INIs into the INI Editor for that profile. Save it when you're done and when that profile is loaded so will be the default INI. Repeat this same process for creating a profile with the ultra INI that can be loaded for testing when needed.
* [https://www.gimp.org/ Gimp]
 
*: A DDS plugin is [https://code.google.com/archive/p/gimp-dds/downloads available for download]. For BC7 support, [https://forums.eagle.ru/showthread.php?t=236816 see these instructions].
'''Wrye Bash Users'''<br/>
* [https://software.intel.com/en-us/articles/intel-texture-works-plugin Intel Texture Works Plugin]
Navigate to the INI Tweaks folder in Skyrim's Data folder. This folder will only be present if you have installed Wrye Bash. Create two new text files and name one Default Medium (or High) Mod Test Skyrim.ini, and the other Default Ultra Mod Test SkyrimPrefs.ini. Make sure that your two text files change from .txt to .ini. Once these have been created, copy the contents of the default INIs into their respective INI files you just created. The same should be done for your normal/custom settings that you play Skyrim with, but name the resulting INIs differently, such as My Skyrim.ini, or My SkyrimPref.ini
*: Plugin for DDS formats for Adobe Photoshop.
 
* [https://www.getpaint.net/ Paint.NET]
This will allow you to easily switch between mod testing INIs and your normal INI settings. To apply the INI settings, right click on the INI file in Wrye Bash and chose apply. Be warned that if you would like to remove the applied INI settings, you cannot do so from Wrye Bash. For example, if you apply your normal INI settings to your mod testing INI setting, you will overwrite many INI settings. However, if your mod testing INI settings contain entries that do not exist in your normal INIs, then these entries will remain. Only entries that exist in both will be overwritten. It is easier just to copy your settings from your normal INI files, delete the text inside your Skyrim.ini and SkyrimPrefs.ini, and paste the copied text inside if you wish to revert back to your personal settings. This can also be done from your backups.
* [https://developer.nvidia.com/nvidia-texture-tools-exporter Nvidia Texture Tools]
 
*: Standalone tool and Adobe Photoshop plugin available.
====uGrids====
 
This INI setting ''MUST'' be set to the default value of 5. For those of you who use a value of 7 and above, be warned that these higher values are 100% inherently unstable. It may be stable as a rock for you, but please don't test a mod with anything but the default value of 5. The chance that a new mod may cause stability issues with higher uGrids values is very high, and again, most Skyrim players will be using the default value. To easily switch between uGrids values, create the relevant INI files for your mod manager, as mentioned in the section above.
 
Should you attempt to test a mod on a save game that used to have a higher uGrids value, you will be unable to load it. There are two solutions to this. The first is to start a new game, which is highly preferred. The second option is to use a selection of vanilla saves that can be downloaded under the Save Game Archive section.
 
Default uGrids Settings (Skyrim.ini)
<pre>
[General]
uGrids=5
uExterior Cell Buffer=32
</pre>
 
====SKSE INI====
This INI tweak will help to keep your saved games clean of issues related to scripts and is highly recommended for increased stability. The SKSE.ini does not exist and will need to be created. In your SKSE folder, located in the Skyrim Data folder, create a new text document, copy and paste in the code below and save the document as SKSE.ini.
 
<pre>
[General]
ClearInvalidRegistrations=1
</pre>
 
====Papyrus Logging====
 
These INI tweaks will allow you to see if mod issues are caused by errors in the mods scripts. Not all mods will contain scripts though. Again the easiest way to apply these is create a sperate INI file in your mod manager. This tweak is applied to the Skyrim.ini file. The log files can be found where your save games are located, in the Scripts folder.
 
Papyrus Logging (Skyrim.ini)
<pre>
[Papyrus]
bEnableLogging=1
bEnableTrace=1
bLoadDebugInformation = 1
</pre>
 
= Mod Testing Setup & Profiles =
''This page is still under development. More or reviewed information will be added/edited.''
 
==Mod Managing Programs==
Any modder should be using a proper mod manager such as Mod Organizer (MO) or Wrye Bash (WB). Please note that Nexus Mod Manager (NMM) is no longer supported by STEP. Using these programs is a must for any Mod Tester. The choice of which mod manager to use is yours; however, Mod Organizer has proven more helpful for mod testing purposes. Both managers have different merits:
 
'''[[Guide:Mod_Organizer|Mod Organizer]]''' (recommended)
 
MO creates virtual folders when installing mods, which means it will keep the Skyrim directory clean. This can help in troubleshooting. It can also create profiles, similar to SIS.
 
'''[[Guide:Wrye_Bash|Wrye Bash]]'''
 
==Skyrim Installation Swapper / Mod Organizer==
 
These are essential utilities for mod testers.
 
To quote the author; "Skyrim Installation Swapper (SIS) let's you create up to ten individual Skyrim installation "profiles" which can be swapped in and out easily, via GUI or hotkey. For those familiar with Mod Organizer (MO), MO can be used to do the same thing.
 
The use of one of these utility is important regarding testing, because a mod must be tested against a vanilla Skyrim setup (no mods at all) and a full Baseline STEP modded Skyrim setup. These programs makes it much easier to switch between the two without the hassle of multiple re-installs.
 
[http://skyrim.nexusmods.com/mods/19034/ Skyrim Installation Swapper]
 
[http://skyrim.nexusmods.com/mods/1334/ Mod Organizer]
 
== Mod Testing Setup ==
: ''Reference the [[Guide:Skyrim Installation|Skyrim Installation Guide]] as needed ... this is required reading for all mod testers''. Peruse (or post questions to) the [http://forum.step-project.com/forumdisplay.php?fid=54 mod testing forum] ... guessing is not standard procedure.
 
===Overview===
* Skyrim installed in a non windows directory, if able.  Preferably something like E:\Games\Steam\steamapps\common\skyrim
* All DLC's installed and cleaned with TES5edit.  (Just what you own, you don't need to buy stuff just to test)
* All Unofficial Patches installed  (Just for the DLCs you own)
* All INIs with Vanilla Med to High settings.
 
====General Setup====
<ol><li> Ensure a clean install of Steam and Skyrim (non-windows directory) </li>
<li> Use [http://www.creationkit.com/TES5Edit_Mod_Cleaning_Tutorial TES5Edit to clean any relevant DLC content] present </li>
* Optional: use [http://forum.step-project.com/showthread.php?tid=228&pid=2517#pid2517 DDSopt to fix the vanilla textures]
<li> Install ''and properly configure'' utilities and extenders </li>
* [http://skse.silverlock.org/ SKSE]
* [http://skyrim.nexusmods.com/mods/6 BOSS]
* [http://skyrim.nexusmods.com/mods/1334 Mod Organizer] and/or [http://skyrim.nexusmods.com/mods/1840 Wrye Bash]
* [http://skyrim.nexusmods.com/mods/25859 TES5Edit]
* [http://skyrim.nexusmods.com/mods/5755 DDSopt] (Latest stable version. Also replace the INI with the [http://wiki.step-project.com/Guide:DDSopt_%26_Texture_Overhauls/DDSoptINI STEP INI])
* [http://skyrim.nexusmods.com/mods/19034 Skyrim Installation Swapper] (Not needed if you've chosen MO as your mod manager.)
* [http://www.fraps.com/ FRAPS] (For performance benchmarking)
* Your preferred capturing program. STEP recommends the paid version of FRAPS, but no need to spend money to test unless you want to.
<li> Start a new game, play through until you leave Helgen, and save as soon as the dragon flies away after exiting the cave.</li>
</ol>
 
====SIS Profile Setup====
If you've chosen to use Wrye Bash, you'll need SIS. Follow these instructions for setting it up.
<ol>
<li> Within SIS, name current #1 profile to "Single Mod Test" </li>
<li> Copy/save profile to #10 slot, naming as "Vanilla" using SIS </li>
<li> Copy/save profile to #2 slot, naming as "STEP Mod Test", then select as "Active Profile" using SIS </li>
<li> Install Core STEP mods expected in next release (list provided by admin in [http://forum.step-project.com/forumdisplay.php?fid=54 mod testing forum]) </li>
<li> Become familiar with the mod to be tested: </li>
* Read the mod-site description
* Carfully review any available documentation (i.e., within mod package and relevant mod forums)
<li> In SIS, activate the Single Mod Test profile and install the mod to be tested using WB or MO. Provide feedback by completing the ModTest Form on the wiki (in development) </li>
<li> In SIS, activate the STEP Mod Test profile and install the mod to be tested using WB or MO. Provide feedback by completing the ModTest Form on the wiki (in development) </li></ol>
 
====Mod Organizer Profile Setup====
Mod Organizer is the recommended mod manager for testing. One reason is its built in profile manager. To set up various profiles in Mod Organizer follow these instructions:
 
<ol>
<li>Open Mod Organizer and click on the Configure Profiles button at the top.</li>
<li>Click the Create button on the right side of the window that opens.</li>
<li>Type the name of the profile. Suggested profiles are Vanilla, STEP:Core and STEP:Extended.</li>
<ul>
<li>Check the ''"Default Game Setting"'' box for each of the testing profiles.</li>
</ul>
<li>Click okay to save the new profile.</li>
<li>For each profile you can choose have local savegames and automatic archive invalidation or not. For testing:</li>
<ul>
<li>Make sure the ''"Local Savegames box"'' <span style="text-decoration:underline;">is not</span> checked for the testing profiles.</li>
<li>Make sure the ''"Automatic Archive Invalidation box"'' <span style="text-decoration:underline;">is</span> selected for the testing profiles.</li>
</ul>
<li>Click close to return to the main program window.</li>
</ol>
 
You can now switch between profiles at will from the Profile drop-down box located above the Mod List. Mods activated will be profile specific meaning mods active (checked) in your STEP:Core profile will not be active when you switch to your Vanilla profile.
 
= External Testing Procedure =
 
==General Information==
Now that your system is setup for mod testing, the fun begins! External testing is where all testing starts. Use the following steps as a guide to testing any mod externally before moving on to testing them in-game. Each step should be completed and notes taken from each before in-game testing occurs.
 
==External Mod Testing Procedure==
====Step 1 - Opening Post/Workflow====
Read the mod's thread opening post (OP) or workflow in the Mod Testing Forum.
:There, an outline of what needs to be tested for the particular mod can be found. Make note of this and use it when testing begins.
 
 
=====Step 2 - Nexus Page=====
Read the Nexus Page in it's entirety
:Read the mod's Nexus page description completely as well as the changelog (if provided). Make note of any special installation/uninstall instructions, of any known issues with the mod or mod compatibility issues, and of any potential conflicts with the DLCs and/or other STEP mods. The changelog can often provide a sense of where the author is taking the mod and what might be expected from a mod and its author.
 
 
=====Step 3 - Mod's Forums=====
Read the Bethesda, Nexus, and Steam forums
:A complete read is not necessary; however, try to develop a sense of user satisfaction and a list of possible bugs to attempt to confirm or deny. This is also a good way to find out how active the author is with the mod. No replies from the author in a long period of time usually indicates they have been absent or may no longer be actively supporting the mod.
 
 
=====Step 4 - Documentation=====
Examine the documentation included with the mod
:Read the Readme and any other documentation which comes with the mod. Note any lack of clarity, installation/uninstall directions, and general completeness. If the mod does not include documentation, please make note of this as well for the final review and mod page creation.
 
 
=====Step 5 - Validation=====
Validate the archive package, naming scheme, and directory structure using your mod manager or 7zip.
: Observe if the downloaded mod package is properly structured and configured for installation. Detailed information on proper mod package structure for WB can be found [http://wiki.step-project.com/Guide:Wrye_Bash#tab=BAIN_Installers here]. Mod Organizer can also use BAIN type installations; however, FOMODs are preferred which use XML. You can validate the FOMOD XML using an online validation tool. W3Schools has an always up-to-date [http://www.w3schools.com/xml/xml_validator.asp XML Validator].
 
 
=====Step 6 - DDSopt=====
Used DDSopt to determine quality of texture compression for texture mods.
: The [http://wiki.step-project.com/Guide:DDSopt DDSopt Guide] can help; however, knowledge of texture compression and familiarity with DDSopt will be required.
 
 
=====Step 7 - TES5Edit=====
Inspect the mod in TES5Edit to determine quality of edits in any plugin files and the scope of mod
: Note any issues of the mod not carrying over changes from the DLCs and/or from the Unofficial Patches. Also note any conflicts with mods already in STEP. Knowledge of TES5Edit and conflict resolution will be required for this step. Even though it's not for Skyrim, [http://newvegas.nexusmods.com/mods/38413/ this guide] will help in learning TES5Edit.
 
 
=====Step 8 - Installation/Uninstall=====
* Validate the installation procedure
* Validate the uninstallation procedure
:* Note any leftover files which the uninstallation failed to remove
 
 
=====Step 9 - Inspection=====
* Inspect in WB/MO
:* Make note of any file conflicts
::Using a mod manager, take note of any conflicts that appear against vanilla Skyrim files and other STEP mods. The process is different for each mod manager so you should be familiar how to do this in your chosen manager (MO is the recommend manager for testing). For mods with BSA archives, extract these archives into loose files to be able to see the conflicts. This can be done easily using BSAopt for WB users. MO provides the option to extract BSAs during installation of the mod.
 
 
=====Step 10 - Before Testing=====
Enable papyrus logging if it's not already enabled.
: Open your ''Skyrim.ini'' file and scroll down to [Papyrus]. Set ''bEnableLogging=0'' to 1 and save. MO users will need to do this in their profile INI files using the INI Editor.
 
= In Game Testing Procedure =
'' Still to be reviewed.''
==General Information==
This section is the most important and will detail the steps required to test a mod in such a way that it can be recommended for STEP. It will be as simple and streamlined as possible. However, regarding the complexity, breadth and depth of mods for Skyrim, this guide will never be able to cover all testing scenarios. Ultimately, this guide should cover the majority of mod testing scenarios, but when it doesn't use your best judgment.
 
==Testing Procedure==
 
To begin with, the mod you have chosen to test will be examined using several tools to assess viability. This should have been completed from the External Testing tab.
 
Next, the mod will be tested on a vanilla Skyrim profile.
 
Thirdly, the mod will be tested on a complete Baseline STEP Skyrim profile.
 
Lastly, the Mod Testers will write detailed review (as much as possible) about their findings.
 
==Screen & Video Captures==
When screenshots or videos are needed for comparisons, provide them from in-game sources. Do not use "studio" applications to provide shots and/or video. In-game lighting conditions and rendering can change the appearance of many textures compared to studio applications. Therefore, it is very important to capture these comparisons from within the game itself.
 
[http://www.fraps.com/ FRAPS] is an excellent program for both screen and video captures in-game as well as capturing FPS data; however, feel free to use your preferred program for captures. The paid version of FRAPS provides more functionality and is recommended. PNG is the preferred format for screen captures due to its accuracy in capturing correct colors, saturation, tints, etc. JPEG is not recommended because some loss of the image's originality can be lost; however, it can be used if PNG isn't an option. Do '''''not''''' use GIF format for screen captures!
 
For video captures, AVI, MKV, and MP4 file formats (containers) are best. FRAPS will capture videos in the AVI format. Using one of these three formats or a higher quality one for capturing video is very important for proper captures in high definition. If you can set the codec for captures, use H.264 as the first choice and MPEG-4 as a second choice. Video for true HD should be captured in 1080p, not 1080i. Audio for video captures, if it can be set, should be no less than a 48khz sample rate and no less than a 128kbps bit rate (96khz sample/384kbps bit rate is recommended for true HD audio). Use this information for encoding edited videos for compares as well. Adobe Premiere Elements is excellent for this, but rather expensive.
 
When uploading captures for posting compares on the STEP forums, please use a 3rd party service to host your captures. ''Do not store your captures on the STEP wiki!'' [http://imgur.com/ Imgur] has proven to be an excellent free image hosting site for uploading screen captures to. It will re-compress your PNGs to JPEGs without any loss in quality. If using Imgur or JPEGs, please use the inline image functions on the forums to post your compares. For posting video captures, please use YouTube. Other services have proven themselves annoying for members to use; most requiring an account to view the videos. YouTube videos can also be included right in the post using the video clip button in the formatting bar on the forum. As long as you've followed the recommendations above for video captures and encoding, your YouTube videos will be in proper HD.
 
'''Quick tip:''' Unless you're running at a monitor resolution of 1920x1080 or higher and capturing at that resolution, do not encode your videos in 1080p. The result will be blurry due to upscaling. If you're below 1920x1080, 1600x900 for example, encode your videos in 720p.
 
==External Assesment==
 
'''Plugin Assessment'''
 
Using WB, assess the plugin. Right-click on the .esp or .esm plugin and highlight "Mod Cleaning" in WB. In the drop down box, select "Scan for UDR's". This will indicate if the mod is clean or dirty, which should be noted in the review. Once additional programs such as TESVEdit, TESVJedit, and TESVGecko are released a more detailed explanation will be added. This can also be done with BOSS; however, neither of this methods are completely accurate.
 
'''Enable a Vanilla Skyrim Profile'''
 
Enable your vanilla version of skyrim using SIS or MO. Do not start the game yet.
 
'''Generate Default Skyrim.ini & SkyrimPrefs.ini Files'''
 
If you have not already done so using SIS or MO, generate default ini files on medium or high settings with the relevant modifications by following the instructions in the [[Guide:Mod_Testing#tab=Skyrim_Stability__26_Settings|Skyrim Stability and Settings]].
 
'''Papyrus Logging'''
 
During all stages of mod testing, papyrus logging should be enabled. Activate it by changing the relevant ini values in the Skyrim.ini file under Documents/My Games/Skyrim/ (for Win7).
 
 
'''Testing Locations'''
 
* Testing Hall
 
* Riften
 
* Whiterun
 
* Riverwood
 
* Mod Specific
 
=== Helpful Console Commands ===
 
To open the in-game console press the [ ~ ] (tilde) key normally located just below the ESC key. Press it again to close the console.
 
;coc locationName
:Transports you to specified location. Replace the locationName with the name of the location. A list of location names can be found [http://www.skyrimsearch.com/cells.php here].
 
;tgm
:Toggles God Mode on/off.
 
;tcl
:Toggles collisions on/off. Don't use while falling or CTD can occur.
 
;tfc
:Toggles Free Camera Mode on/off
 
;tfc 1
:Pauses Free Camera Mode
 
;tm
: Toggles menus on/off. Useful when taking screenshots. [[Immersive HUD]] can be used to achieve this without having to use the console.
 
==Texture Mod Testing==
 
= Save Game Archive =
''Still to be created and archives added.''
 
==General==
Below are saved game archives that are meant to be used for mod testing purposes only. Using these saves to "skip" ahead in the game is not recommended. All locations have been unlocked for the saves as well. Game setup for saves include:
 
*Skyrim version: 1.9.32.08
*SKSE version: 1.6.16 rel 44
*DLC/Mods
:*Dawnguard
:*Hearthfire
:*Dragonborn
:*Unofficial Skyrim Patch
:*Unofficial Dawnguard Patch
:*Unofficial Hearthfire Patch
:*Unofficial Dragonborn Patch
:*Unofficial High Resolution Patch
 
Note: HRDLC was present in saves; however, they were used as loose files so they have no effect on the save files.
 
==Vanilla Saves==
[http://wiki.step-project.com/images/6/6c/TesterNord_GameStart.7z Tester Nord - Game Start]<br/>
This save is based off a default Nord (male) character which has no customization. Character is at level 1, has no perks assigned, is located just outside the Helgen Keep cavern exit and has all map locations unlocked. This save will be helpful for texture mod compares and testing as you'll quickly be able to switch to different locations around Tamriel.
 
Tester Nord - Archive<br/>
This is a collection of saves based on the above save; however, with character advancements. Character has perks assigned and has completed incremental parts of the storyline (depending on the save loaded). As such, expect to find the character with a range of armor, inventory, and weapons all depending on which save is loaded. These archives will be most helpful when needing to test at a certain point or quest in the game as you'll be able to pick a save that is the closest to the point at which testing is required. This archive will be updated until it encompassed a completed game.
 
= In-Game Utilities =
''Still to be reviewed.''
 
==General Information==
Several in-game tools will be specified here. These tools will for the most part be mods that are particularly useful when it comes to mod testing.
 
 
'''[http://skyrim.nexusmods.com/mods/2006 Elys MemInfo]''' is a SKSE plugin that is very useful for displaying in game resource usage. Currently it is able to show RAM, Pagefile, Virtual Manager, Handles, and VRAM use and utilization by Skyrim. This is most useful when testing mods that affect graphics, such as texture mods, FXAA Injectors, ENB presets, and lighting and shadow tweaks and mods. For example, when testing out texture omptimizer, such as DDSOpt, it is possible to see how much VRAM use has decreased in certain areas. If you are hitting your graphic cards VRAM limit, it is useful to know that the optimizations have lowered VRAM use. Since Elys MemInfo displays this information in game, there is no need to minimize the game to bring up alternative resource use tools such as GPUZ or the Task Manager.  (Requires [http://skse.silverlock.org/ SKSE])
 
 
'''[http://skyrim.nexusmods.com/mods/9557 Alternative Start - Live Another Life]''' is an extremely useful in game testing mod. As explained before, mod testing is best done by starting a new game. One of the issues with testing out one, or many, mods quickly when starting out a new game, is the requirement by Skyrim to watch and play the opening sequence of the game. This mod allows mod testers to simply skip the rather long introduction sequence. For reducing the time required for testing mods, Live Another Life is an invaluable addition. It is also a safe and clean mod, and will not break any quest lines.
 
 
'''[http://skyrim.nexusmods.com/mods/12625 No Boring Sleep Wait Menu]''' allows the tester to wait up to 31 days quickly and easily, which is not possible using the vanilla waiting system.  Skyrim requires a 31 day in-game wait time before as many cells as possible can be reset. Cell resets are useful when mod testing for several reasons. A cell may be badly generated, or you wish to install a mod without starting a new game for testing. In both cases a cell reset will potentially generate a proper cell, and the new mod may be integrated properly, especially if the mod affects spawns.
 
 
'''[http://skyrim.nexusmods.com/mods/15094 ScenicCarriages]''' transforms the non-moving Skyrim carriages to a fully functional carriage ride. This mod is great for bench testing performance within the game. It will allow you to provide more accurate results than if you tried to bench and re-bench by simply walking/running. Simply pay the carriage driver to go from Whiterun to Riften, climb in the back of the carriage, hit your benchmark hot key (FRAPS) and you're off. For best results when using this for benchmarking, use the default settings and don't move the mouse to look around. The ride from Whiterun to Riften will take around 15 minutes and provides a wide range of textures during the benchmark.
 
= External Tools =
''Still to be reviewed.''
 
==General Information==
This page contains a list of programs that will be recommended for use during the testing procedure.
 
==Generic Programs==
 
'''[http://www.techpowerup.com/gpuz/ GPU-Z]''' is an amazing lightweight program that offers a plethora of information regarding any type of gpu you have, as well as allowing logging and graphing of gpu related processes such as vram load, temperature, clock speeds, and far more. This will be the main tool for testing graphic related mods, as its logging ability is very useful here.
 
'''[http://downloads.guru3d.com/NVIDIA-Inspector-1.94-download-2612.html Nvidia Inspector]''' (NI), is a program that allows for in depth gpu information of Nvidia graphics cards. It allows for very fine profile tuning for skyrim, as well as monitors for a range of process such as gpu temperature and vram use.
 
'''[http://www.fraps.com/ FRAPS]''' is an excellent program for capturing both screenshots and video. It's as easy as pressing your Hotkey while in-game. FRAPS is also great at capturing FPS data for performance testing. Both free and paid versions are available; however, if you're serious about Mod Testing and plan on capturing a lot of shots or videos then the paid version, which opens up new (and better) file formats for screenshots and better options overall, is well worth the cost.
 
'''[http://sourceforge.net/projects/frafsbenchview/ FRAPS Bench Viewer]''' is a free tool that graphs out your FRAPS logs from your benchmarks (FPS data) in easy to read visual graphs. This makes it very easy to spot performance issues.
 
====ATI Tools====
 
==Skyrim Focused Programs==
 
* [http://skyrim.nexusmods.com/mods/6491 Skyrim Performance Monitor]
* [http://forums.bethsoft.com/topic/1392239-wipz-tes5dumpfuture-tes5edit/ TES5Edit]
* [http://forums.bethsoft.com/topic/1392239-wipz-tes5dumpfuture-tes5edit/ TES5Dump]
 
= Notes/ Ideas =
== To be added into the guide ...maybe. ==
* Camera mod
 
* wrye bash
:* esmfy esps to fix ctds/ tesvsnip.
 
* saves
:* multiple save files from vanilla setup, heavy exterior areas, heavy interior.
:* link to total cell clear in troubleshooting guide
:* z92's suggestions for 60s run throughs.
 
* in game tools
:* camera mod
 
* software tools
:* skyrim performance monitor, FPS background booster.
 
== Completed Pages ==
* External Testing Procedures
 
<headertabs/>

Latest revision as of 22:20, January 2, 2024

Delta c.png

Step Guide-Mod Testing

An in-depth manual to mod testing for Step Modifications

by: The Step Team  | Forum Topic

To ensure consistent and reliable mod testing, it's essential to minimize variations that can lead to a range of issues and inconsistencies. This guide will outline standardized techniques for mod testing that Step Modifications employs for evaluating all mods featured in our official modding guides. The recommendations provided progress through system and software setup before delving into the mod testing process.

Understanding Mod Testing

Mod testing encompasses various aspects. However, in the context of this guide, it refers to the assessment of mods for potential inclusion in a curated mod list. This evaluation involves several key components:

  1. Stability Testing: assesses a mod's stability when integrated with other mods in the mod list. It aims to identify any conflicts or issues that may arise from mod interactions.
  2. Functionality Testing: mod functionality is scrutinized to ensure it operates as intended. Any deviations from the mod's intended purpose are noted and addressed.
  3. Mod Comparison: mods with similar content are compared to determine which one provides the best solution.
  4. Lore and Mandate Assessments: mods are evaluated against Elder Scrolls lore to ensure they align with the established lore and adhere to the Step Mandates. This ensures that the mod fits seamlessly into the Elder Scrolls universe.

It's important to acknowledge that mod testing can be a time-consuming and meticulous task. Nevertheless, it can also be rewarding and enjoyable. Mod testing is ideally suited for individuals who are genuinely dedicated to the process. Consequently, turnover rates among users involved in official testing are high, as many underestimate the demands of mod testing; quickly become overwhelmed by the complexity of the task.

Following is described the detailed process required for testing mods in a manner that ensures consistency and facilitates recommendations (or not) for a Step Game Guide. Our aim is to maintain a process that is straightforward and efficient, yet given the complexity and extensive nature of some mods, this process may not encompass every conceivable mod testing scenario. While common scenarios are provided, it's crucial for testers to exercise best judgment when faced with situations not explicitly covered.

System Preparation

Before embarking on mod testing, it is essential to establish a stable system and game installation. Without them, distinguishing whether a mod is incompatible with the mod list or the system becomes significantly more challenging. Testers should have their systems configured according to one of the Step Game Guides. Nevertheless, here are some general reminders and best practices to ensure the environment is adequately prepared for mod testing.

General Setup

  • Ensure the System Setup Guide is complete
  • Ensure a clean and pure installation of the Step Game Guide for which testing is being performed
    A pure installation means nothing exists within the mod list that isn't included in the Game Guide; the installation should be 100% within the bounds of the Guide.

Game Settings

All game INIs, launcher, and in-game settings should be configured according to the Game Guide for which testing is being performed. Therefore, any post-installation changes should be reverted back to the Guide's instructions for the duration of testing.

Mod Organizer Profile Setup

Step Modifications' officially supported mod manager is Mod Organizer, and it proves itself more helpful than other managers for mod testing. Follow these instructions to set up two new profiles in Mod Organizer for testing:

  1. Open Mod Organizer and select the instance for the game for which testing is being performed
  2. Select the Profiles MO.png icon
  3. Copy the Step Game Guide profile
  4. Name the new profile: Vanilla
    • Make sure the Local Savegames box is not checked for the testing profiles
    • Make sure the Automatic Archive Invalidation box is selected for the testing profiles
  5. Name the new profile: GuideName vX.X Testing
    • Make sure the Local Savegames box is not checked for the testing profiles
    • Make sure the Automatic Archive Invalidation box is selected for the testing profiles
  6. Select the newly created Vanilla profile and ensure no mods are enabled

Vanilla Save

Though playing through vanilla content may be at the top of anyone's list, this step is not optional. A vanilla save point is required for some comparisons, as well as, providing a default environment from which to start the majority of testing.

  1. Select the Vanilla profile
  2. Start a new game from this Vanilla profile
  3. Play through any introductory quests until the first point is reached that allows for free roaming of the game
  4. Once at a free roaming point, save the game
    • Fallouts: play until at the starting vault's exterior
    • Skyrim: play until at the exterior of Helgen cave
    • Starfield: play until the Frontier can be freely piloted and save at NA Spaceport
    Tip: Use the console to create a save with a custom name for quick reference. (save SaveName)


External Testing Procedures

All testing begins outside the game. Each of the following steps should be completed and notes taken from each before proceeding to in-game testing.

Step 1 - Forum Mod Topic

Read the mod's topic opening post (OP)

The mod's topic OP often contains an outline of what needs to be tested for a particular mod. Make note of this and use it when in-game testing begins. If nothing is outlined in the OP, it's likely the mod has not been tested or reviewed enough to include it. In such cases, testers will establish a outline by editing the OP. This outline should include what mod options should be tested, how to test, steps for making the mod compatible with other mods, etc. Most of this information will be gathered from the actual testing process below.

Step 2 - Nexus Page

Read the Nexus Page in its entirety

  • Description: make note of any special installation/uninstall instructions, any known internal or mod compatibility issues, and of any potential conflicts with supported DLCs and other mods within the Step Game Guide.
  • Posts: a complete read is not necessary; however, testers should attempt to develop a sense of user satisfaction. Posts can also reveal a list of possible bugs not listed within the Bugs section. Unless a mod is fully developed with few to no bugs being reported, some sort of interaction from the mod author is preferred to ensure the mod isn't abandoned.
  • Changelog: changelogs often provide a sense of what direction the mod it headed, how often issues are addressed, features being edited, etc.
  • Bugs: review any active bug reports. Too many bugs may disqualify a mod from being included within a Step Game Guide.

Step 3 - Validation

Validate the archive package using MO or 7zip

Observe if the downloaded archive is properly structured and configured for installation or not. For more complex installations, Mod Organizer FOMODs are preferred; however, MO can install BAIN type installations as well. FOMODs can be validated using an online validation tool, XML Validator, or by using FOMOD Validator. When installing mods using Mod Organizer, the bottom pane will also have a report of potential issues with the package.

Step 4 - xEdit

Inspect plugins using xEdit

Knowledge of xEdit and conflict resolution is required for this step. Load the entire Step Game Guide and the mod being tested with xEdit. Review and note any issues of the mod failing to carry forward changes from DLCs, mods, and patches included within the Step Game Guide. These notes help with creating correct conflict resolution via official patches.

Step 5 - Installation/Uninstall

  • Validate installation procedure listed on the Nexus page.
  • Validate uninstallation procedure listed on the Nexus page.

Step 6 - Inspection

Inspect the installation in MO

  1. Install the mod as it will be used for testing
  2. Run LOOT and note information
    Unless the mod is new on the scene, LOOT will recognize it and provide some valuable information such as if the mod is clean or dirty, requires other mods, etc.
  3. Using Mod Organizer, take note of any asset conflicts that appear against vanilla files and other mods in the Step Game Guide.
    Extract any BSAs to ensure the conflicts are being read. BSAs should not remain extracted unless required for further testing. Otherwise, remove the extracted BSA contents before continuing any testing.

Step 7 - Mandate

The final step is to evaluate the mod against the Step Modifications Mandate. Ensure the mod does not fall into the "...not about" sections. If it does, no more testing is required. Post findings why the mod doesn't fit the Mandate to the mod's topic. If the mod succeeds in passes this step, continue on to the remainder of testing the mod.


Testers should update the mod's topic OP on the forums with any relevant information gathered from the above testing.


In-Game Testing Procedures

This process is the most important and will detail steps required for testing mods in a consistent way so they may be recommended (or not) for a Step Game Guide. It will be as simple and streamlined as possible, however, with the complexity, breadth, and depth that mods can be, this process will never be able to cover all mod testing scenarios. Below we provide the most common of scenarios, however, when the scenario isn't covered best-judgment must be used.

Info-Logo.png
NOTE:
The process for capturing comparison screenshots can be found following these procedures; which are for gameplay testing.


Pretesting Setup

Enable the testing profile
Testing for Step Game Guides should be completed from the profile set up, above, for that Guide in Mod Organizer: GuideName vX.X Testing.

Step 1 - The Vanilla Experience

It's important to be familiar with the original content whether it be textures, quests, game mechanics, etc. Therefore, if there is no familiarity with the changes being tested, the original content should be experienced first. If familiarity does exist this step may be skipped. To complete this step:

  1. Load the Vanilla profile in MO, launch the game, and load the Vanilla save
  2. Fast travel to or use the command console to load the area closest to the mod's altered content
    Tip: before starting the content, make a new save that can be used later for faster testing
  3. Play the game for a period of time to experience or view the vanilla content
  4. Close the game and review findings for the next step

Step 2 - Experience the Mod

  1. Relaunch Mod Organizer and select the Testing profile
  2. Activate the mod being tested
  3. Relaunch the game and load the Vanilla save or a save created for testing from Step 1
  4. Allow the mods to initialize
  5. Play the game for a period of time; assessing the mod:
    • Does it work as intended?
    • Does it look as intended?
    • Does it fit in with the game's content/ambiance/environment?
    • Are there any issues?
  6. Close the game and review the findings

Final Step - Review

  1. Gather the findings from all testing sources including the External testing.
  2. Summarize a review and post this on the mod's topic on the Step Forums. Content to include are, but not limited to:
    • Issues with file structure and installation
    • Conflicts with vanilla or guide content (and solutions, if any)
    • Whether the mod met or fell below expectations
    • Any in-game issues
    • Personal assessment of whether the mod should or shouldn't be included in a Step Game Guide
Info-Logo.png

NOTE

Be mindful to remain objective. Do not write anything that will reflect upon the mod's author in a personal manner. Only review the craftsmanship, reliability, operation, etc of a mod, itself. Mods are assessed for guide inclusion, not for judgment against authors!


Capturing Comparison Sets

When testing mesh and/or texture based mods, comparison screenshots are required and are to be posted for the community to review. These shots are not for the staff to use for evaluation, since in-game testing should be completed, but rather they are for the community's benefit and staff reference.

Screenshots and videos are provided them from in-game sources. Do not use "studio" or "editor" applications! In-game lighting conditions and rendering can change the appearance of many game assets; therefore, it's important to capture these comparisons from within the game, itself. Any capture software may be used as long as the saved image is a 1:1 match in color and quality to the in-game image. Some recommendations can be found within the External Tools header below.

Warning-Logo.png

NOTE

Do not use PNG as the file format when posting compares on the forums. They tend to be large files, which in turn cause long loading times on pages. JPG/JPEG should be sufficient and is about one quarter the payload of PNGs. Only use PNG when transparency is required.

Capture Procedure

Comparison shots and videos need to include:

  1. Vanilla reference
  2. current Guide reference
  3. mod reference

This process will allow captures to be of the exact same reference point, in each capture, with the only difference being asset replacements.

  1. Active a HUD mod that auto-hides the HUD for all MO profiles, including Vanilla (i.e, for Skyrim active Immersive HUD). This will auto-hide the HUD so that it doesn't have to be done manually from the console. If the Game Guide doesn't include one of these mods, the HUD will have to be manually hidden or remain present in the captures.
  2. Load the Vanilla profile and Vanilla save file
    The mod being tested should only be active in the Testing profile.
  3. While in-game, locate the vanilla reference(s) that need to be captured.
  4. Once the reference is found, line the capture up in the frame
    • Pay attention to lighting and angles to make sure the capture will be good for compares.
    • Ensure nothing will interfere in the shot such as an NPC walking into the frame.
  5. Once the capture is lined up, create a new save
  6. Now load the save that was just created
    Do NOT touch the mouse! Doing so may cause the capture to because misaligned.
  7. Once loaded, ensure there is no temporary text on the screen and the HUD has been hidden
    Manually hide the HUD (see commands below) or simply leave it in the capture when no mod exists for auto-hide.
  8. Take the capture using the hot key for the capture software being used
  9. Exit the game
  10. Switch to the Game Guide profile
  11. Repeat steps 6-9 above for the Guide captures
  12. Switch to the Testing profile
  13. Active the mod being tested and ensure its conflict resolution is as desired
  14. Repeat steps 6-9 above for the mod captures

Posting Captures

Post the comparison capture(s) on the Step Forums. Repeat this process for all assets that require a comparison set for any given mod. When only one asset is being tested, it is encouraged to provide several captures from various angles/locations/lighting situations for a more complete review.

When posting captures on the Step Forums:

  • Please use the Editor buttons/functions on the forums to post.
  • Use a 3rd party service to host captures. Do not store your captures on the Step Wiki!
    • Imgur and Postimage have proven to be an excellent, free image hosting sites for uploading screen captures to.
    • Use YouTube for hosting video captures.
      Other services have proven themselves annoying for community members to use; most requiring an account to view the videos.


Info-Logo.png

NOTE

The remainder of the guide contains helpful console commands, tips, tools, and more.


Helpful Console Commands

Provided is a list of helpful console commands to use while testing. They are specific to Bethesda games.
To open the in-game console press the ~ (tilde) key, which is normally located just below the Esc (escape/exit) key on a standard keyboard. Press it again to close the console.

Toggles

  • tmm 1
    Toggles all map markers on; thus allowing fast travel to any location. Enter 0 in place of 1, to reset to default.
  • tgm
    Toggles God Mode on/off. While in God Mode the PC will be invincible with unlimited health, magicka, and stamina.
  • tcl
    Toggles collisions on/off; thus allowing the PC to walk through anything.
  • tfc
    Toggles Free Camera Mode on/off. tfc 1 will pause the camera.
  • tm
    Toggles menus on/off. Useful when taking captures.
  • tai
    Toggles all NPC AI on/off. NPC will typically not move when toggled off.
  • tcai
    Toggles all NPC Combat AI on/off. NPCs will interact normally, but will not actively attack the player.

Player Commands

  • player.additem formID ###
    Adds the item to the player's inventory.
    Replace formID with the baseID of the item. These IDs can be found here. Replace the ### with the number of items to add.
    For example, to add gold in Skyrim: player.additem f 200
    Tip: leading zeroes can be dropped from IDs. So 0000000f becomes just f.
  • player.addspell formID
    Adds a specified spell to the player's spell list. Spell IDs can be found here.

Targeted Commands

Targeted commands require the reference to be selected in the console. To target a reference, use the mouse to click on it while the console is open.

  • disable
    Disables a targeted, enabled reference.
  • enable
    Enables a targeted, disabled reference.
  • Kill
    Kills a targeted NPC.
  • Resurrect
    Resurrects a dead NPC.
  • unlock
    Unlocks a targeted object (doors, chests, etc).

Other Commands

  • coc locationName
    Transports the player to a specified location. Replace locationName with the name of the location.
    A list of Skyrim location names can be found here and here.
    coc qasmoke is Skyrim's developer testing hall with containers for all game items.
  • killall
    Kills all non-essential NPCs within the player's vicinity.
  • set timescale to ##
    Changes the timescale of the game.
    Change ## to the desired value. 20 is default. Setting below 10 may cause issues.

External Tools

Capture Software

Feel free to use the preferred program for captures. Some 3rd party software used by the staff include:

Screen Captures

The preferred format for screen captures is PNG due to its lossless nature. JPEG can be used as an alternative and is recommended for large comparison sets to reduce page loads. Do not use GIF format for screen captures! The simple solution for screen captures for some games will be to utilize their own built-in capture feature:

  • Skyrim: use BethINI to set the capture path and use the PrtSc (print screen) key
  • Fallout 4: hotkey the photo mode capture key

Video Captures

The preferred formats (containers) for video captures are AVI, MKV, or MP4. Using one of these formats or a higher quality one is important for proper video captures in high definition. Capture in at least 1080p for fullHD, but always in a 16:9 format. Also use the following information for encoding:

  • Use H.264 codec; MPEG-4 as a second option
  • Audio: no less than a 48khz sample rate and no less than a 128kbps bit rate (96khz sample/384kbps bit rate is recommended for true HD audio)

Texture Viewers

Retrieved from "https://stepmodifications.org/wiki/index.php?title=STEP:Mod_Testing&oldid=187571"