cs-board-tools documentation¶

cs-board-tools is a Python library that allows loading and validating user content that is compatible with Fortune Avenue and Custom Street Map Manager (CSMM). Check out the Usage section for further information.

Note

This project is under active development. As such, you might encounter bugs. If you see any strange behavior, please report it! Doing so will help us find and fix as many issues as possible.

What would you like to do?¶

Load a Board

Loading a board for value comparison, or just to gather data about the boards available.

./usage.html#loading-boards

Validate a Board

Validate a board to ensure it meets Custom Street standards. It’s no fun when someone’s game crashes due to a misconfiguration.

./usage.html#validating-boards

Indices and tables¶

Index
Module Index
Search Page

Site Map¶

Home
- What would you like to do?
Getting Started
Usage
API Reference
- cs_board_tools
  - cli
    - bundle
    - descriptor
    - frb
  - errors
  - io
    - bundle
    - frb
    - yaml
  - queries
    - frb
  - schema
    - analysis
    - bundle
    - descriptor
    - frb
    - validation
  - utilities
    - collections
    - filesystem
    - yaml
    - zip
  - validation
    - board
    - consistency
    - filesystem
    - main
    - music
    - naming
    - network
    - paths
    - results
    - venture