# @18xx-maker/export-rb

> Exports 18xx-maker data into ruby files

Latest version **3.0.0** (published 2020-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @18xx-maker/export-rb
pnpm add @18xx-maker/export-rb
yarn add @18xx-maker/export-rb
bun add @18xx-maker/export-rb
```

Provides the command `18xx-export-rb`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-06-21 |
| First published | 2020-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 25.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christopher Giroir |
| Maintainers | kelsin |

## Links

- npm: https://www.npmjs.com/package/@18xx-maker/export-rb
- Repository: https://github.com/18xx-maker/export-rb
- Homepage: https://github.com/18xx-maker/export-rb#readme
- Issues: https://github.com/18xx-maker/export-rb/issues
- npm.io page: https://npm.io/package/@18xx-maker/export-rb

## Dependencies (4)

- [ramda](https://npm.io/package/ramda.md) ^0.27.0
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.6
- [@18xx-maker/games](https://npm.io/package/@18xx-maker/games.md) 4.0.0-4

## Recent versions

- 3.0.0 (latest) — 2020-06-21
- 2.1.0 — 2020-06-15
- 2.0.4 — 2020-06-13
- 2.0.3 — 2020-06-13
- 0.3.4 — 2020-05-07
- 0.3.3 — 2020-05-07
- 0.3.2 — 2020-05-07
- 0.3.1 — 2020-05-07
- 0.3.0 — 2020-05-07
- 0.2.3 — 2020-05-07
- 0.2.2 — 2020-05-07
- 0.2.1 — 2020-05-07
- 0.2.0 — 2020-05-07
- 0.1.0 — 2020-05-07
- 0.0.1 — 2020-05-07

## README

# 18xx-maker/export-rb

[![build](https://travis-ci.org/18xx-maker/export-rb.svg?branch=master)](https://travis-ci.org/18xx-maker/export-rb)
![version](https://img.shields.io/npm/v/@18xx-maker/export-rb)
![downloads](https://img.shields.io/npm/dt/@18xx-maker/export-rb)
![license](https://img.shields.io/npm/l/@18xx-maker/export-rb)

This package exports files needed to load 18xx-maker data into ruby projects,
specifically in the format that [18xx.games](https://www.18xx.games/) requires.

## Usage

You can use this package from node or via the command line.

### CLI

When you npm install this package globaly:

```shell
npm install -g @18xx-maker/export-rb
```

you end up with a script that can output all tiles, or game files directly:

```shell
# Render the tiles file
18xx-export-rb tiles

# Render some games
18xx-export-rb game 1830
18xx-export-rb game 1889
```

### Node

To use this package in node:

```javascript
const exportRb = require("@18xx-maker/export-rb");

// All tiles are in exportRb.tiles
// All games are in exportRb.games

// Render tiles
const tilesRb = exportRb.renderTiles(exportRb.tiles);

// Render a game
const gameRb = exportRb.renderGame(exportRb.games["1830"]);

// If you have a game json that's not from @18xx-maker/games
// you can render that too:
const otherGameRb = exportRb.renderGame(require("./18Awesome.json"));
```

---
_Source: https://npm.io/package/@18xx-maker/export-rb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
