https://github.com/heyitsgilbert/mazerats

Create PC's, NPC's, and monsters in PowerShell!
https://github.com/heyitsgilbert/mazerats

Last synced: about 2 months ago
JSON representation

Create PC's, NPC's, and monsters in PowerShell!

• Host: GitHub
• URL: https://github.com/heyitsgilbert/mazerats
• Owner: HeyItsGilbert
• License: mit
• Created: 2019-05-26T16:17:25.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T04:31:51.000Z (over 1 year ago)
• Last Synced: 2025-09-18T08:47:40.321Z (6 months ago)
• Language: PowerShell
• Size: 604 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MazeRats

A MazeRats PC and NPC generator in PowerShell!

[![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/MazeRats)

![PowerShell Gallery Version](https://img.shields.io/powershellgallery/v/MazeRats)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/HeyItsGilbert/MazeRats/.github/workflows/CI.yaml?branch=main)

![PowerShell Gallery](https://img.shields.io/powershellgallery/p/MazeRats)](https://www.powershellgallery.com/packages/MazeRats/)

Docs automatically updated at [heyitsgilbert.github.io/MazeRats](https://heyitsgilbert.github.io/MazeRats/)

Available via the [PowerShell Gallery](https://www.powershellgallery.com/packages/MazeRats/)

## Overview

This is a PowerShell module created to make it easy to spin up Maze Rats

characters.

The source for this comes from [Maze Rats](https://questingbeast.itch.io/maze-rats)

Please support Ben by buying a copy of the game. While this module will make it

easy to play digitally, you'll still want to have a copy of the rules.

## Installation

```powershell

Install-Module MazeRats

```

Or you can fetch it from the [Powershell Gallery](https://www.powershellgallery.com/packages/MazeRats)

## Documentation

The docs are generated as part of the buid and are rendered into the Docs folder.

These are available here :[Help docs](https://heyitsgilbert.github.io/MazeRats/)

## Developing

1. Clone the repo

1. Download the necessary modules via

   * `.\build.ps1 -Bootstrap`

1. I recommend using VSCode and the built in tasks.

## Examples

```powershell

PS > $joe = New-MazeRat

PS > $joe

Name           : Fitzhugh Crumpling

Level          : 1

XP             : 0

Strength       : 2

Dexterity      : 0

Will           : 1

Attack         : 0

Armor          : 0

Health         : 4

MaxHealth      : 4

SpellSlots     : 0

Appearance     : Brawny

PhysicalDetail : Bushy eyebrows

Background     : Sellsword

Clothing       : Practical

Personality    : Know-it-all

Mannerism      : Slow speech

Spells         : {}

PS >

```