Skip to content
Blockchain library for persistent peer-to-peer online games
Branch: master
Clone or download
dahlia Merge pull request #255 from dahlia/build-metadata
Denote build metadata only to VersionSuffix
Latest commit 5bbe183 May 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.azure-pipelines Change xunit runner version to net461 May 22, 2019
.github Denote build metadata only to VersionSuffix May 23, 2019
.idea/.idea.Libplanet/.idea
.vscode .NET Core Apr 25, 2019
Docs Fix docs builds for pull requests May 20, 2019
Libplanet.Stun.Tests MSBuild 2003 format May 20, 2019
Libplanet.Stun Replace tcs to AsyncProducerConsumerQueue for _connectionAttempts May 23, 2019
Libplanet.Tests Remove Swarm.Add() usages. May 22, 2019
Libplanet
hooks .NET Core Apr 25, 2019
.editorconfig Pre-commit hook to check BOM Feb 19, 2019
.gitignore Nupkg distribution using GitHub Actions May 10, 2019
.travis.yml
CHANGES.md Replace tcs to AsyncProducerConsumerQueue for _connectionAttempts May 23, 2019
CONTRIBUTING.md Use Azure Pipelines instead of Travis CI May 14, 2019
LICENSE Relicense to LGPL 2.1 or later Jan 17, 2019
Libplanet.ruleset
Libplanet.sln
Libplanet.sln.DotSettings Add words to custom dictionary (spellchecker) Apr 3, 2019
Menees.Analyzers.Settings.xml Menees.Analyzers.2017 Feb 8, 2019
README.md Use Azure Pipelines instead of Travis CI May 14, 2019
azure-pipelines.yml Force dotnet if running on mono May 22, 2019
codecov.yml Codecov.io settings Feb 13, 2019
stylecop.json Apply StyleCop.Analyzers.ruleset Nov 25, 2018

README.md

Libplanet

Discord Build Status Codecov NuGet NuGet (prerelease)

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.

NuGet

For every stable release, we pack Libplanet into a .nupkg and upload it to NuGet and GitHub releases page. (You can find the 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 every day 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.20181231235959 where 20181231235959 is a UTC timestamp of the build. For a daily build, a version name is like 0.1.0-nightly.20181231.

Unfortunately, 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 the next few minor releases. In the near future, we are going to submit it to Unity Asset Store too.

Build

You could build a Libplanet.dll and Libplanet.Stun.dll assemblies from the source code.

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

dotnet build

Note that dotnet command is distributed together with .NET Core SDK.

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

You can’t perform that action at this time.