Libplanet is a .NET library for creating multiplayer online game in decentralized fashion, which means the whole gameplay occurs on a peer-to-peer network among equal nodes rather than an authorized central server. Under the hood, it incorporates many features (e.g., digital signature, BFT consensus, data replication) of a blockchain.

For every stable release, we pack Libplanet into a .nupkg and upload it to NuGet and GitHub releases page. (You can find changelog for versions from releases page.) To use Libplanet in your game, your project needs to add a dependency to Libplanet package. On Visual Studio IDE, run the following command in Package Manager Console:

Install-Package Libplanet

If you prefer dotnet CLI run the following command instead:

dotnet add package Libplanet

See also Microsoft's docs on different ways to install NuGet package.

In addition to stable releases, we also provide pre-release packages. For everyday and every merge commit, it is packed into a .nupkg and uploaded to NuGet with a hyphen-suffixed version name.

For a merge commit build, a version name is like 0.1.0-dev.123+20181231 where 123 is a build number in our CI system and 20181231 is a date of the build. For a daily build, a version name is like 0.1.0-nightly.20181231.

Unfortuneatly, Unity currently does not support NuGet. There are some Unity plug-ins to deal with NuGet package system, and these seem immature at present. To use Libplanet on Unity, you need to manually extract Libplanet.dll from Libplanet.*.nupkg file and place it inside of your Unity project. We are acknowledging the fact Libplanet is currently not very usable together with Unity, and promise to make it better in next few minor releases. In the near future, we are going to submit it to Unity Asset Store too.

You could build a Libplanet.dll assembly from the source code.

The following command installs dependencies (required library packages) and builds the whole Libplanet solution:

msbuild -r

Note that msbuild is distributed together with Mono framework or Visual Studio.

If you'd like to contribute code to the Libplanet project in earnest, please read our contributor guide.