Skip to content

a-rr/18xx-maker

 
 

Repository files navigation

18xx Maker

build version downloads license

This app can take 18xx game definitions written in json, display them, and render them for printing. The original intent of this site was for personal PnP projects, but the purpose has shifted over time to prototyping new games.

This project was bootstrapped with Create React App. The application version is created using Electron. The ui was made with Material-UI.

License

The code of this project is licensed under the MIT License but the games contained within are not covered by this. The games are presented with no license from 18xx-Maker with the permission of the publisher/designers. They have given us permission to include their game in this repo so that you can make print and play copies for your own personal use. If you need to inquire about the license for a particular game you need to get in contact with the publisher and/or designer.

Chat

We have an #18xx-maker channel in the public 18xx slack.

Usage and Documentation

Please check out the documentation for information about how to use this app to prototype your own 18xx games.

Donation

I've been asked about donation buttons; if you find this software useful to you and would like to donate money towards its development you can do so via paypal or square cash.

Schemas

CLI Usage

Install this package gives you a 18xx-schemas binary that takes in any number of globs and validates each file it can find. If a file doesn't exist it just ignores it. It then pretty prints the validation output using ansi colors on the terminal.

# Validate some files
18xx-schemas games/*.json tiles/**/*.json config.json

# Display all options
18xx-schemas -h

# Output version
18xx-schemas -v

Be warned that if you pass a json that doesn't conform to any of the 18xx-maker json schemas it will be validated against the tiles schema.

From this repo you can run this with yarn schemas like the following:

# Display all options
yarn schemas -h

About

Prototype 18xx React Library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 94.8%
  • CSS 2.3%
  • SCSS 2.1%
  • Perl 0.3%
  • Harbour 0.2%
  • Dockerfile 0.2%
  • HTML 0.1%