Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reloaded-project/reloaded.assembler
Minimal .NET wrapper around the simple, easy to use Flat Assembler written by Tomasz Grysztar. Supports both x64 and x86 development.
https://github.com/reloaded-project/reloaded.assembler
csharp fasm game-hacking hacking memory process-manipulation windows x64 x86 x86-64 x86-x64
Last synced: 3 months ago
JSON representation
Minimal .NET wrapper around the simple, easy to use Flat Assembler written by Tomasz Grysztar. Supports both x64 and x86 development.
- Host: GitHub
- URL: https://github.com/reloaded-project/reloaded.assembler
- Owner: Reloaded-Project
- License: lgpl-3.0
- Created: 2018-12-23T00:08:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T04:57:20.000Z (11 months ago)
- Last Synced: 2024-11-06T03:07:12.152Z (3 months ago)
- Topics: csharp, fasm, game-hacking, hacking, memory, process-manipulation, windows, x64, x86, x86-64, x86-x64
- Language: C#
- Size: 783 KB
- Stars: 35
- Watchers: 4
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Project Reloaded: Assembler Library
x86 Assembly is like IKEA Furniture
# Introduction
Reloaded.Assembler is a minimal .NET wrapper around the simple, easy to use Flat Assembler written by Tomasz Grysztar.
It combines the standard tried and tested `FASM` DLL and a and the recent experimental official `FASMX64` DLL to provide JIT, on the fly assembly of user supplied mnemonics inside x86 and x64 programs.
## Getting Started
To get started, install the package from NuGet and simply create a new instance of the `Assembler` class from the `Reloaded.Assembler` namespace:
```csharp
var assembler = new Assembler();
```
And, uh... well... that's it.
From there you can call `GetVersion()` to retrieve the version of FASM assembler that the wrapper wraps around and assemble mnemonics with `Assemble()`.
### Example
```csharp
var asm = new Assembler();
string[] mnemonics = new[]
{
"use32",
"jmp dword [0x123456]"
};
byte[] actual = asm.Assemble(mnemonics);
// Result: 0xFF, 0x25, 0x56, 0x34, 0x12, 0x00
```
Just don't forget to dispose the assembler when you're done 😉,
```csharp
assembler.Dispose();
```
### Small Tip
If the assembly operations fail, the wrapper library will throw an exception with a summary of the error.
You can obtain a slightly more detailed versions of the exceptions by catching them
explicitly and checking their properties.
```csharp
try { asm.Assemble(mnemonics); }
catch (FasmException ex)
{
// Assembler result (e.g. Error, OutOfMemory) : ex.Result
// Original text given to the assembler: ex.Mnemonics
// Line of text error occured in: ex.Line
// The error itself: ex.ErrorCode
}
```
## Reloaded Assembler Compared to FASM.NET
Reloaded.Assembler is not the only standalone library that exposes FASM to the world of .NET. For a while now, there has been another wrapper worth mentioning willing to fulfill the same purpose.
Below is a quick list of differences you should expect when using Reloaded.Assembler as opposed to `FASM.NET`; and some of the reasons why I decided to write this library
### Advantages
- Does not require the Visual C++ Runtime to operate.
- Can be used in both x64 and x86 applications vs only x86.
- No memory allocation on each assembly request, reuses the same buffers resulting in better performance.
### Other Differences
- Reloaded.Assembler is written in pure C#, FASM.NET is written in C++/CLI.
- Reloaded.Assembler has a slightly more minimal interface.
## Misc Notes
Version 1.0.0 of the library uses custom modified FASMX64.
(Official version at the time had a bug in DLLEntryPoint that prevented it from loading).
Version 1.0.1 and onward use the official FASMX64 DLL.
## Other Links
Flat Assembler forums post : https://board.flatassembler.net/topic.php?p=207558#207558
This post briefly describes the changes I made to the experimental `FASMX64` DLL for version 1.0.0 of this library that made it consumable from C# (and likely other high level languages).
## Contributions
As with the standard for all of the `Reloaded-Project`, repositories; contributions are very welcome and encouraged.
Feel free to implement new features, make bug fixes or suggestions so long as they are accompanied by an issue with a clear description of the pull request 😉.