Insomniac games cache simulation tool plugin for UE4

Last update: Aug 27, 2022

Related tags

Overview

Insomniac Games CacheSim plugin for UE4

This plugin for Unreal Engine 4 lets you use the Insomniac Games Cache Simulation tool to detect cache misses in your games.

CacheSim is a cache simulator developed by Insomniac Games. In its current form it simulates an AMD Jaguar cache configuration.

For more information on how CacheSim was developed and how it works internally, you can check out this GDC 2017 slide deck.

The talk is available on the GDC vault with full video as well.

How to use

Copy the Plugins folder to your project.
Open your project.
Enable the plugin in the Plugins window.
Add the following code to any Blueprint (the player controller or the level Blueprint are good candidates for this).

Make a build of your game in any configuration you want and make sure you include the debug symbols with it.
Open the packaged game and press the key you set up before. The game should freeze for a bit.
Open the CacheSimUI-x64-Release/CacheSimUI.exe binary included in this repo or compile it yourself from the ig-cachesim repo.
Open the report that has been generated next to the game's executable.

Known issues

Do not use it inside the editor. It will most likely crash.

Debbugers get really confused if you try capture when they are attached to the process. Solution: Run detached!

Third Party Software

CacheSim has the following license

Copyright (c) 2017, Insomniac Games All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

A game - or rather, a simulation - of a non-Euclidean world.

neuc A game - or rather, a simulation - of a non-Euclidean world. Currently, I am just developing a 2D top down game (and having a blast in general).

3 Nov 28, 2021

Open-source, cross-platform, C++ game engine for creating 2D/3D games.

GamePlay v3.0.0 GamePlay is an open-source, cross-platform, C++ game framework/engine for creating 2D/3D mobile and desktop games. Website Wiki API De

3.9k Jan 8, 2023

A C math library targeted at games

Kazmath Kazmath is a simple 3D maths library written in C. It was initially coded for use in my book, Beginning OpenGL Game Programming - Second editi

506 Dec 31, 2022

3D games console based on RP2040 and iCE40 UP5k

PicoStation 3D This is an unfinished, untested project to develop a 3D games console based on an RP2040 microcontroller and an iCE40 UP5k FPGA. Quick

37 Sep 12, 2022

A set of libraries and tools to make MSX games using the C programming language.

ubox MSX lib This is a set of libraries and tools to make MSX games using the C programming language. There are three main components: ubox: thin wrap

42 May 30, 2022

TIC-80 is a fantasy computer for making, playing and sharing tiny games.

3.8k Jan 4, 2023

Enfusion Artifical Intelligence for DayZ and future Bohemia Interactive games.

Enfusion AI Project (eAI) This mod adds headless player units under the control of a script on the server. Although the script is very rudimentary now

61 Nov 26, 2022

Game engine behind Sea Dogs, Pirates of the Caribbean and Age of Pirates games.

693 Dec 29, 2022

Recast is state of the art navigation mesh construction toolset for games.

Navigation-mesh Toolset for Games

5.2k Jan 7, 2023

Comments

no Qt platform plugin could be initialized

Hello, Is there any steps to getting the submitted GUI Tool running? I get the following message when trying to run it (tried on multiple machines).

Thanks!

opened by DanBreton 2