The pyprototypr documentation consists of the sections described below.
Although its great to be able to just “jump in” and start using a program, these sections are designed to be read in order - apart from the examples, they all contain useful information and build on each other.
- Overview - a brief introduction of the purpose and rationale of pyprototypr
- Setting Up - how to get pyprototypr working on your computer
- Basic Concepts - core aspects of pyprototypr that you must know
- Basic Worked Examples - step-by-step examples of setting up and running scripts to generate cards
- Script Anatomy - how a script is constructed
- Additional Concepts - additional aspects of pyprototypr that can also help with script creation
- Core Shapes - a tour of the core geometries available and how to construct them
- Card Decks - how to create a deck, or set, of cards/tiles
- Advanced Commands - how to work with common/reused items and repetitive elements
- Customised Shapes - how to refine the appearance of certain kinds of shapes
- Layouts - how to work with different kinds of layouts
- Hexagonal Grids - how to create designs or layouts on a hexagonal grid
- Terminology - common jargon, and descriptions of elements' properties
- Using Python Commands - how to work with loops and if statements for more flexibility
- Descriptions of Available Examples - brief walkthoughs of many of the examples provided with pyprototypr
- Development Notes - notes for programmers wanting to develop further in or with pyprototypr
- Useful Resources - links to tools and websites related to boardgame prototyping