KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

NXPorts

★ 45 Open GitHub ↗

A platform agnostic tool to export .NET functions at build time.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# NXPorts

[![CI](https://github.com/MeikTranel/NXPorts/workflows/CI/badge.svg)](https://github.com/MeikTranel/NXPorts/actions)
[![NuGet Gallery Release](https://img.shields.io/nuget/v/NXPorts.svg)](https://www.nuget.org/packages/NXPorts/)
[![codecov](https://codecov.io/gh/MeikTranel/NXPorts/branch/master/graph/badge.svg?token=DPMCO9NGN5)](https://codecov.io/gh/MeikTranel/NXPorts)

A MSBuild-integrated library/tool to expose entrypoints in .NET assemblies to the platform invocation system or short `PInvoke`.
It allows you to build .NET libraries that can be called from any development platform that supports `PInvoke`, including **C++**, **C**, **Rust**, **Delphi**, **Python** and so on...

## Getting Started

To get started you only have to add the `NXPorts` package to your project. That's it. `NXPorts` will automatically generate exports as
part of your build now. Some samples are available [here](./samples).

### Prerequisites

This software itself will run on any system that supports developing .NET software - it does **not** have any dependencies on
`ildasm.exe`, `ilasm.exe` or any other windows-only libraries.

Keep in mind that `Reverse PInvoke` - calling PInvoke entrypoints **in .NET assemblies** - is only officially supported
in the .NET Framework. It may work in other runtimes as well, but your mileage may vary.

See [Compatibility Docs](./docs/Compatibility.md) for more info.

### Sample

The following code will result in an exported function named `SampleExportFunc`.

```CSharp
public static class Exports {
  [DllExport(alias:"SampleExportFunc")]
  public static double Add(double a, double b)
  {
      return a + b;
  }
}
```

## Building from Source

To build packages by yourself all you have to do is the dotnet cli like this:

```shell
  dotnet pack
```

This will restore, build and pack all available projects. Testing this project is just as simple:

```shell
  dotnet test
```

## Releasing NXPorts

To start releasing a new NXPorts version you just have close the associated milestone.
GitHub actions will then generate a checklist issue with further guidance.

**Fundamentals**:

- We're releasing to ``production`` (as in NuGet Gallery) from `tagged` builds
- We're releasing ``canary`` builds from master to our canary feed (GPR)

## Contributing

I am more than happy to take in PRs.
Documentation regarding Marshalling, PE32 or PInvoke (especially on non-NETFX runtimes) counts
just as much as a valuable contribution as any other code PR.

To me writing issues is also just as valuable. I may not list every issue reporter in the release notes, but
especially during the initial development timeline knowing the shortcomings of the software is absolutely invaluable.

### Guidelines

* Please consider writing an issue first
* Please target PRs towards the `master` branch

NXPorts

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README