Besides creating the actual CryENGINE builds on a regular schedule, it can be quite useful to create automatic performance benchmarks.
CryENGINE is a high performance 3D engine, which is able to render beautiful scenes at a high frame rate. However, there is always a chance that certain changes or additions made to your game project will affect the performance negatively. A line of badly written code or a few un-optimized assets might lower your frame rate considerably.
Being able to catch those performance issues early on is very important. The sooner a performance issue can be identified, the sooner it can be fixed.
Automated performance tests can help you spot those issues as soon as they appear.
Performance file generated using the save level stats command
CryENGINE has the ability to generate so-called level statistics files, which contain a lot of information about the performance situation of the level. By reviewing and comparing those files, it is easy to identify any existing performance problems. The level statistics file for a level can be generated manually using the savelevelstats console command. Let's give it a try and generate a level statistics file for your level.
Open the level you want to profile in Sandbox.
Type
savelevelstatsinto the console.
Depending on your computer and the size of your level, it might take several minutes to generate the level statistics file.
The higher the object count of your level, the longer the process will take. The savelevelstats command will collect detailed information about every object in your level, hence the higher the object count, the longer the process will take.
Once the statistics file has been generated, let's open it up and have a look at the details.
Go to the …/TestResults folder.
Open
levelname.xml.
You can see that the statistics files have been generated as .xml files. You will need to use MS Excel to view the files. If you do not have access to MS Excel, you can just download the free Excel file viewer from http://www.microsoft.com/en-us/download/details.aspx?id=10.
Now, let's have a look at what has been generated. Take a moment and browse through the information contained in the files. You will see that there is a lot of relevant information contained in the documents. Everything from the overall loading time of your level up to the polygon count of individual assets can be found. You can use all this information to create a comprehensive picture of the performance situation of your build.
A more detailed description of the individual entries in the level statistics file can be found in the official CryENGINE documentation found at http://freesdk.crydev.net.
You might have noticed that the level statistics files we just generated, although being very comprehensive, only show a snapshot of the performance situation of our level. They provide us with performance data from just the point in time they have been created.
Only collecting performance data over a longer period of time will allow you to see certain trends and developments.
Once your build scripts are set up to generate the level statistics automatically, you could also combine the gathered information in one easy-to-read document.