# mtg-json

> A module for interacting with the MtG JSON website, a site providing a series of JSON files that act as a database for Magic the Gathering Cards

Latest version **1.0.1** (published 2015-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install mtg-json
pnpm add mtg-json
yarn add mtg-json
bun add mtg-json
```

## 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 | 1.0.1 |
| Published | 2015-12-16 |
| First published | 2015-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | TMiguelT |
| Maintainers | tmiguelt |
| Keywords | magic, gathering, mtg, json |

## Links

- npm: https://www.npmjs.com/package/mtg-json
- Repository: https://github.com/TMiguelT/node-mtg-json
- Homepage: https://github.com/TMiguelT/node-mtg-json#readme
- Issues: https://github.com/TMiguelT/node-mtg-json/issues
- npm.io page: https://npm.io/package/mtg-json

## Dependencies (3)

- [request](https://npm.io/package/request.md) ^2.67.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.0.6
- [event-to-promise](https://npm.io/package/event-to-promise.md) ^0.6.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2015-12-16
- 1.0.0 — 2015-12-16

## README

# MtG JSON

## Introduction

This module is designed for interacting with the [MtG JSON website](http://mtgjson.com/), a site providing
 a series of JSON files that act as a database for Magic the Gathering Cards.

 You might be interested in this module if you're making any kind of node app involved with Magic the Gathering,
 for example a database, simulator, etc.

 The scope of this module can include anything to do with the website, and currently is able to download and
 read all 8 files stored in the website.

## Compatibility

This module uses some features from ES6, so requires node version 4.0 and greater.

## Usage

### Quickstart

* First install the module:
   `npm install mtg-json --save`

* Then require the module and call it:
    ```javascript
        //Require the module
        const getMtgJson = require('mtg-json');

        //Request AllCards.json and store it in the current directory
        getMtgJson('cards', __dirname)

        //Use the json data
          .then(json => {
              let stormCrow = json['stormCrow'];
              console.log(stormCrow.types) // Logs ['Creature']
          });
    ```

### API

The module consists of one function with the following signature: `getMtgJson(type, directory, opts)`

* `type` (string): Required. Either `'cards'` or `'sets'`, to determine if you want a file organized by card or by set. See the [MtG JSON website](http://mtgjson.com/) for details.

* `directory` (string): Required. The directory in which to place or look for the JSON file. This may often be `__dirname`, the current directory constant, but you must set this yourself, `__dirname` is not the default.

* `opts` (object): Options. An object with three optional keys:
	* 	`extras` (boolean): True if you want the file to include extras (rulings, printings, foreign language names etc.). Again, see the MtG JSON website for details.
	* 	`zip` (boolean): True if you want the file to be downloaded as a zip file. If this is true, the promise return value will be a filepath, and not JSON.
	* 	`returnFile` (boolean): True if you want the promise to resolve with the json filename, rather than the JSON data itself. True by default if `zip` is true.

## Tests
The module is quite comprehensively tested. Simply run `npm test` or `mocha test.js` twith Mocha globally installed to run the tests. Note that these can take a while (about a minute) because they actually involve downloading the large JSON files from the website a number of times.

---
_Source: https://npm.io/package/mtg-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._