go-gma

module
v5.0.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2022 License: BSD-3-Clause

README

Coverage Status GitHub

go-gma

Golang port of the GMA core API libraries.

This is a work in progress. Only a small portion of the GMA API core library has been ported to this point.

GMA?

This is part of a larger project called GMA (Game Master's Assistant) which is a suite of tools to facilitate the play of table-top fantasy role-playing games. It provides a GM toolset for planning encounters, tracking character state, and running encounters in a comprehensive way. This includes a multi-user interactive tactical battle map where players can move their tokens around the map, initiative is managed automatically, etc.

While we intend to open source GMA eventually, it's not quite ready for general use (mostly because it needs to be generalized more to be playable on multiple game systems and less tied to the author's game group). The manual describing the full GMA product may be downloaded here (PDF, 61Mb).

In the mean time, we're porting one part of the GMA suite (the interactive map server) to Go for increased stability and performance, which we will release as open source ahead of the rest of GMA, since it's independent of the generalization issues that are gating the release of GMA.

To support this, the go-gma repository holds parts of the core GMA API needed by the map server.

Documentation

API docs may be viewed at pkg.go.dev.

Versioning

We are keeping the version numbers for this project in sync with the main GMA project, so version x.y.z of go-gma will always be compatible with version x.y.z of gma. (This is why go-gma started at at v4. It moved to v5 when the JSON formats were introduced as a breaking change.)

GMA uses trademarks and/or copyrights owned by Paizo Inc., used under Paizo's Community Use Policy (paizo.com/communityuse). We are expressly prohibited from charging you to use or access this content. GMA is not published, endorsed, or specifically approved by Paizo. For more information about Paizo Inc. and Paizo products, visit paizo.com.

Directories

Path Synopsis
Package auth calculates the challenge/response for a login attempt, and checks user input to determine if it was a valid response to the challenge.
Package auth calculates the challenge/response for a login attempt, and checks user input to determine if it was a valid response to the challenge.
cmd
Package dice provides a general facility for generating random numbers in fantasy role-playing games.
Package dice provides a general facility for generating random numbers in fantasy role-playing games.
Package mapper implements a standard client interface for the mapper service.
Package mapper implements a standard client interface for the mapper service.
Package namegen implements random name generation.
Package namegen implements random name generation.
Package tcllist converts between Tcl list strings and Go slices.
Package tcllist converts between Tcl list strings and Go slices.
Package text provides text processing facilities used by GMA.
Package text provides text processing facilities used by GMA.
Package util provides miscellaneous utility functions that don't deserve their own package.
Package util provides miscellaneous utility functions that don't deserve their own package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL