Home

Awesome

wham

NuGet packages CI GitHub Action License

WarHub.ArmouryModel library and wham tool

Foundational .NET library for wargame datafile tools, written in C#.

Overview

This is the home of the WarHub.ArmouryModel library handling wargame roster and data files. It consists of:

All libraries, unless otherwise specifed, target .NET 6.

There are also test projects and WarHub.ArmouryModel.Source.CodeGeneration project which contains code generator used to build .Source library. This code generator uses C# Source Generators.

Usage

wham installation

To install wham command line tool:

  1. please install .NET SDK v7 for your platform.
  2. In your shell/command line run dotnet tool install wham -g
  3. You can check if the tool is available: wham --version should show what version exactly is running.

This will install preview of wham CLI tool in your user-space (not system global), and so it doesn't require root/admin permissions. (Although installation of .NET SDK can).

wham features

wham usage

You can always run wham -? or wham -h or wham [action] -? to get help about the tool/action.

Development

The development branch is the main branch. Stable releases are marked via vX.Y.Z tags. This project uses Nerdbank.GitVersioning package that automatically generates version numbers for assemblies and packages from git tree. It won't work if the git clone is shallow or otherwise incomplete.

Credits

The library is MIT licensed (license in repo root). Created by Amadeusz Sadowski (@amis92). BattleScribe name is used without permission under fair-use laws.