An open API service indexing awesome lists of open source software.

https://github.com/steveplays28/nularc

Packet-based, lightweight C# UDP networking library.
https://github.com/steveplays28/nularc

csharp dotnet library multiplayer networking udp

Last synced: 4 months ago
JSON representation

Packet-based, lightweight C# UDP networking library.

Awesome Lists containing this project

README

          

![Nularc icon](docs/img/icon_128x128.png)

# Nularc

[![GitHub](https://img.shields.io/github/license/Steveplays28/nexlib)](https://github.com/Steveplays28/nexlib/blob/main/LICENSE)
![GitHub](https://img.shields.io/github/repo-size/Steveplays28/nexlib)
[![GitHub](https://img.shields.io/github/forks/Steveplays28/nexlib)](https://github.com/Steveplays28/nexlib/network/members)
[![GitHub](https://img.shields.io/github/issues/Steveplays28/nexlib)](https://github.com/Steveplays28/nexlib/issues)
[![GitHub](https://img.shields.io/github/issues-pr/Steveplays28/nexlib)](https://github.com/Steveplays28/nexlib/pulls)

Packet-based, lightweight C# UDP networking library.

## Installation

### NuGet

#### Visual Studio

Install Nularc via the NuGet package manager UI built into Visual Studio.
For more information, see the [Microsoft Documentation](https://learn.microsoft.com/en-us/nuget/quickstart/install-and-use-a-package-in-visual-studio).

#### .NET CLI

```bash
dotnet add package Nularc
```

For more information, see the [Microsoft Documentation](https://learn.microsoft.com/en-us/nuget/quickstart/install-and-use-a-package-using-the-dotnet-cli#add-the-newtonsoftjson-nuget-package).

### DLL/manual install

Download the [latest release](https://github.com/Steveplays28/nularc/releases/latest), extract it into your project, and add the following to your `.csproj` file (inside the `` tag):

```cs


PATH\TO\Nularc\Nularc.dll

```

> Make sure to change the path to the location of the dll!

## Contributing

If you want to give a suggestion, or add/change something, feel free to [open an issue](https://github.com/Steveplays28/nularc/issues/new)/[create a pull request](https://github.com/Steveplays28/nularc/compare)!
Please check if there isn't already an issue/pull request open.

### Development environment

Requirements:

- [.NET 6 SDK](https://learn.microsoft.com/en-us/dotnet/core/install/windows?tabs=net60)
- [.NET CLI](https://learn.microsoft.com/en-us/dotnet/core/tools/)

```bash
git clone https://github.com/Steveplays28/nularc.git
cd nularc

dotnet build
```

### Documentation

If you want to edit the documentation, run the following commands to get a local, editable copy of the documentation up and running:

```bash
git clone https://github.com/Steveplays28/nularc.git
cd nularc

docsify serve ./docs
```

You can now preview your changes to the documentation at [localhost:3000](http://localhost:3000).

## License

This project is licensed under the LGPLv2.1 License, see the [LICENSE file](https://github.com/Steveplays28/nexlib/blob/main/LICENSE) for more details.