MemoryIO 1.1.0

dotnet add package MemoryIO --version 1.1.0                
NuGet\Install-Package MemoryIO -Version 1.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MemoryIO" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MemoryIO --version 1.1.0                
#r "nuget: MemoryIO, 1.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MemoryIO as a Cake Addin
#addin nuget:?package=MemoryIO&version=1.1.0

// Install MemoryIO as a Cake Tool
#tool nuget:?package=MemoryIO&version=1.1.0                

MemoryIO

A C# library designed around conveniently reading and writing data in memory. Provides interfaces and implementations to interact with process memory and perform data manipulation.

MemoryIO

The core interface IMemoryIO defines methods for reading and writing data of generic unmanaged objects, strings, and byte arrays. WindowsMemoryIO and LinuxMemoryIO provide platform-specific access to a Process memory using kernel32 and libc respectively. The ProcessMemoryIO implementation is a wrapper class to allow for platform-independant Process memory manipulation based on Environment.OSVersion.Platform.

BaseMemoryIO provides a simple way to implement an IMemoryIO object by only needing to provide implemention for ReadData and WriteData.

MemoryMonitors

MemoryMonitors are designed to allow for monitoring memory regions and raises a MemoryChanged event when the data in those regions changes. Each MemoryMonitor is designed to monitor different structures in memory. Such as an unmanaged generic, a region of bytes, or an array of unmanaged generics.

The MemoryChangedEventArgs, MemoryRegionChangedEventArgs, and MemoryArrayChangedEventArgs provide information about the address and value of the memory that changed. MemoryArrayChangedEventArgs also provides which index in the monitored array had changed.

Examples

Reading
ProcessMemoryIO MemoryIO = new(Process.GetCurrentProcess());

// ProcessMemoryIO exposes the underlying Process to easily access its Modules/BaseAddress
IntPtr address = MemoryIO.Process.MainModule.BaseAddress + 0x12345;

// Read an unmanaged struct from address
SomeStruct value = MemoryIO.Read<SomeStruct>(address);

// Read an array of five integers from address
int[] values = MemoryIO.ReadArray<int>(address, 5);

// Read a null-terminated string using Encoding.Default from address (reads up to 512 bytes by default)
string valueAsString = MemoryIO.ReadString(address, Encoding.Default);

// Read a null-terminated string up to 16 characters long using Encoding.Default from address
string valueAs16CharacterString = MemoryIO.ReadString(address, Encoding.Default, 16);
Writing
ProcessMemoryIO MemoryIO = new(Process.GetCurrentProcess());
IntPtr address = MemoryIO.Process.MainModule.BaseAddress + 0x54321;

// Write a null-terminated string to the memory at address using Encoding.UTF8
MemoryIO.WriteString(address, "All your memory are belong to us", Encoding.UTF8);

// Write raw byte data to the memory at address
byte[] myData = new byte[] { 0x00, 0x01, 0x02, 0x03 };
MemoryIO.WriteData(address, myData);

// Write an array of unmanaged generics to the memory at address
SomeUnmanagedStruct[] myStructs = new SomeUnmanagedStruct[3];
MemoryIO.WriteArray(address, myStructs);
Monitoring
ProcessMemoryIO MemoryIO = new(Process.GetCurrentProcess());
IntPtr address = MemoryIO.Process.MainModule.BaseAddress + 0x54321;
CancellationTokenSource cts = new();

// MemoryMonitorFactory provides a convenient way to create multiple MemoryMonitors using a single IMemoryIO
MemoryMonitorFactory monitorFactory = new(MemoryIO);

SomeUnmanagedStruct[] myStructs = new SomeUnmanagedStruct[3];
var myStructArrayMonitor = monitorFactory.GetArrayMonitor<SomeUnmanagedStruct>(address, 3);

myStructArrayMonitor.MemoryChanged += (object? sender, MemoryArrayChangedEventArgs<SomeUnmanagedStruct> e) =>
{
	// MemoryArrayChangedEventArgs provides 
	//	the Address of the array being monitored, 
	//	the Value of the item changed, and
	//	the Index of the item in the array
	myStructs[e.Index] = e.Value;
};

var monitorTask = myStructArrayMonitor.StartMonitoringAsync(cts.Token);

Credit

Inspired by https://github.com/JamesMenetrey/MemorySharp.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MemoryIO:

Package Downloads
MemoryIO.Pcsx2

An implemention of MemoryIO specifically for the PCSX2 emulator: https://github.com/PCSX2/pcsx2

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 172 6/11/2023
1.0.2 252 6/10/2023
1.0.1 130 6/10/2023
1.0.0 147 6/10/2023 1.0.0 is deprecated.

Removed dependency on MemorySharp's MarshalType and removed it from the project. Added BaseMemoryIO for simplier implementations of IMemoryIO.