Vements.API 0.0.8

There is a newer version of this package available.
See the version list below for details.
dotnet add package Vements.API --version 0.0.8
NuGet\Install-Package Vements.API -Version 0.0.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Vements.API" Version="0.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Vements.API --version 0.0.8
#r "nuget: Vements.API, 0.0.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Vements.API as a Cake Addin
#addin nuget:?package=Vements.API&version=0.0.8

// Install Vements.API as a Cake Tool
#tool nuget:?package=Vements.API&version=0.0.8

Build and Test

Vements Client Library for C#

The Vements Client Library for C# is a C# library for accessing the Vements API. It also includes a command line tool that can be used to interact with the API in scripts or in a terminal.


See the Getting Started Guide for more information on how to use this library.


The package is available on NuGet.

To install the Vements Client Library for C#, use the following command:

$ dotnet add package Vements.API --version 0.0.3


The following example shows how to use the Vements Client Library for C# to create a new Vements client, and then use that client to create a new Vements scoreboard.

using Vements.API;


var client = vements.Client();
var scoreboard = client.create_scoreboard(display="My Scoreboard", rank_dir="desc", public=False);

Command Line Tool

The Vements Client Library for C# includes a command line tool that can be used to interact with the Vements API. The command line tool supports all of the same operations as the API.


To build the CLI:

$ dotnet publish -c release -r osx-arm64 --self-contained

Substitute osx-arm64 with the appropriate runtime identifier for your platform, e.g.: linux-x64, linux-arm64, win-x64, win-arm64, etc.

$ vements --help
Achievements and scoreboards for everyone

Usage: vements [command] [options]

  --api-key       API Key
  --verbose       Verbose output
  -?|-h|--help    Show help information.

  achievement     Achievement operations
  api-version     Show API version
  client-version  Show client library version
  participant     Participant operations
  scoreboard      Scoreboard operations

Run 'vements [command] -?|-h|--help' for more information about a command.

The C# CLI tool supports all of the same operations as the CLI tool in other languages:

  • achievement CRUD, list, leaderboard, record progress
  • participant CRUD, list, progress, scores
  • scoreboard CRUD, list, scoreboard, record score

The above commands all support the following options:

  • --api-key to specify the API key
  • --verbose to show verbose output

In addition to resource commands, these common commands are also supported:

  • api-version to show the API version
  • client-version to show the client library version

The library and CLI both support the following environment variables:

  • API_KEY to specify the API key
  • SERVER_TAGS to specify the tags used to select the server URL
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Vements.API:

Package Downloads

Achievements and Scoreboards for Everyone

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.9 157 11/26/2023
0.0.8 116 11/24/2023
0.0.7 109 11/23/2023
0.0.6 117 11/17/2023
0.0.5 96 11/17/2023
0.0.4 99 11/16/2023
0.0.3 93 11/16/2023