mtgjson / mtgjson-website

MTGJSON Documentation Front-End Application built with VitePress

MTGJSON Documentation Application

Getting Started

Installation

Install Node with brew:

brew install n
sudo n 16.16

Developing

Runs the local build server with hot module reloading and eslint watcher.

npm run dev

Linting

Manually lint the files for any breaking changes.

npm run lint

Testing

Run all tests.

npm run test

Run all tests and a test build.

npm run test:full

Building

Build out the entire site as a static project.

Note: This is done via the GitHub Action and pushed to a Release Tag so no need to do this unless you are testing the actual build. Additionally, when submitting a PR, Netlify will deploy an environment for you to test your Pull Request.

npm run build

Purging

Clean out all Node packages and Vitepress cache.

npm run purge

You can also just purge the Vitepress cache with the following.

npm run purge:cache

mtgjson-website's Issues

Add sorting options for Individual Deck downloads

Add sorting to the Individual Decks download page for filtering pre-constructed decks.

Functionality exists for Individual Sets already, perhaps turn this in to a helper.

Basic rarity not documented

Like the title says, the "basic" value is missing from the docs on the "rarity" field.

Add single zip with separate set JSON files

V3 had a single zip-file that contained a JSON file for each set, it would be very useful for me if v4 got that too, if it's not too much trouble.
I know there's the Sets page, where I could download all the sets separately, but that's more cumbersome and I fear also a bit more error-prone. And it may cost you more bandwidth too.
Thanks!

Doc informations

cards: Should change next release: starter -> isStarter
sets: Missing tcgplayerGroupId, isFoilOnly
tokens: Missing isOnlineOnly

Update sets page with release dates for all sets

See mtgjson/mtgjson#97 (comment)

sets page: show names in bold

For simple highlighting reasons the most important information on that page, the name of each set, should be bold.

isReserved Missing from card structure documentation

isReserved is missing from the documentation.

Add Magarena

https://github.com/magarena/magarena

#217 not documented yet (codeV3)

New field

Add open graph image for sharing

Add og:image to generic meta data so an image shows up when sharing the link.

Here are the requirements: https://www.h3xed.com/web-and-internet/how-to-use-og-image-meta-tag-facebook-reddit

Do note the suggestion is a square image that gets cropped from top and bottom

no rss feed available to follow updates

Unlike v3 there is no newsfeed available for subscribing to new releases and changes.

Language Strings Differ from Documentation

MTGJSON Version: 4.2.2

Description of Bug:

The documentation states the range of values for language in foreignData as including:
"Portuguese", "Simplified Chinese", and "Traditional Chinese"

The values in AllSets.json are actually:
"Portuguese (Brazil)", "Chinese Simplified", and "Chinese Traditional"

Better documentation for AllCards

Been implementing the whole card document inside my software and was setting up the rarity field. However, I realized that it stayed default for every card. That's when I noticed that, in both my .json and the online .json, the field is simply missing. Is that a bug, on purpose or I'm just crazy? I'd like to have rarities to add it as a filter parameter.

Missing several sets

Not sure if this'd be better as a GitHub issue, but I just downloaded all the separate set zips, and the zips for sets F18, L16, and L17 give me a 404 error. From Didero

Incorrect set documentation for field type

MTGJSON Version: 4.2

Description of Bug:

I used the documentation to create my own C# client. I created an enum type for SetType since the documentation stated that it could only be one of few values. Now I try to parse all the sets and I got a parse error:

Error converting value "treasure_chest" to type 'MtgJson.Models.SetType'. Path 'type', line 11138, position 28.

I was working with PZ2.json.

The documentation did not specify this set type.

who we serve - image issues

• DideRobot uses a github logo
  Should be removed and listed down with the other "no logo" services

• MagicFetchBot has no logo
  Should be listed down with the other "no logo" services

A hint below the trable that the list is "Sorted alphabetically with all icons first" would be nice, too.

New site to about page

https://github.com/Didero/DideRobot

change menu on the right

I don't really like the weird menu box on the right. :)
It misaligns the design and provides no big benefit.
Instead, there could be simple icons on the upper menu bar for discord and github links.

The pelican sidebar looks to be disigned for a wiki style page with a lot of links on the right...
https://github.com/getpelican/pelican-themes/tree/master/pelican-bootstrap3#screenshot

It can easily be disabled:
https://github.com/getpelican/pelican-themes/tree/master/pelican-bootstrap3#sidebar-options

The icons in the menu header could come from https://simpleicons.org/ (CC0).
Then, all content is central and looks less misplaced, it should play better in terms of responsive design as well.

---

Now:

Proposal:

Added new fields, changed one default

mtgjson/mtgjson#261

Force overflow auto/scroll for schemas in Mobile view

When viewing a mobile render of a data schema, like AllCards, when a right column value breaks the column of the pseudo-table it does not force it's parent to cause a scroll effect. Instead, the text breaks the table and causes a page level horizontal scroll.

Landcycle does not parse multiple variables in schemas

Landcycle does not update multiple variables in a schema. It will only parse and replace the last identified variables and either semi-parse or ignore the others.

Likely something to do with async/await. May require a full Promise-based function and the use of Promise.all.

This issue is a future bug that could rear it's face.

Comments after recent changes (#27)

Thanks for taking care of these updates, I think the page looks better now and has more complete information. 👍

Although - after #27 - I've some comments and questions:

• Why don't we use the correct discord logo in the button, but a gamepad instead?
• In the File Manifest, the SET.json phrase could link to the sets page maybe?
• I would like to have something like a sub-menu at the top of the documentation with an overview of what is contained (Card, Token, Set, Keywords...). One could then click "Token" and jump to this part of the documentation directly.
• The available file extensions are named in the changelog, but they will get burried there and nobody will search for it there.
  Can we have this info in the documentation as well?
  Or a separate download menu point? The file manifest could go to that page too for example.
• version.json is named in the manifest, but not properly documented as all the other files. Docs should be comprehensive, even for the trivial cases :)

Missing field values in documentation

There are some fields missing from the documentation.

Rarity is missing

timeshifted rare
timeshifted uncommon
timeshifted common

Set type is missing

treasure_chest

CSS clips text in code

For the fixed-width code in the structure pages, letters with descenders (g, y, p, etc.) are clipped

Either reducing the first padding number for the rule .content code to something like .125, or setting the line-height to 1.4 would solve it.

#34 not documented yet (AllSetFiles)

Should show up in documentation / file manifest probably.

V3 -> V4 Changelog

Individual Sets

Added:

• meta (Better understanding of when data was created)
• mtgoCode (Determine MTGO set name)
• tokens (Tokens have made it in!)
• foilOnly (If a set is available only in foil, like sliver premium deck)

Removed:

• gathererCode (No longer necessary)
• magicCardsInfoCode (No longer in service)
• border (Moved to individual cards)
• booster (Will be re-added in v4.1)

Individual Cards:

Added:

• frameVersion (Determine the frame type)
• hasFoil (Card available in foil)
• hasNonFoil (Card available in non-foil)
• isOnlineOnly (Card only available online)
• isOversized (Card is HUGEEE)
• foreignData (All foreign printings from the set and data relating)

Removed:

• source (Hard to validate)
• mciNumber (No longer in service)
• life (Will re-add whenever Vanguard support is re-implemented)
• hand (Will re-add whenever Vanguard support is re-implemented)
• imageName (No longer a thing)
• variations (Each printing will have it's own entry)

Changed:

• cmc is now convertedManaCost
• convertedManaCost is a float over an int
• multiverseid is now multiverseId (with capital I)
• flavor is now flavorText
• border is now borderColor
• id is now uuid
• legalities formatting has changed
• loyalty is now a string

Add planestrader

planestrader.com

version in header should link to changelog entry

add dr4ft + decklist as user

https://github.com/dr4fters/dr4ft (I will upload a svg to the repo at one point)

https://decklist.org/ (no logo)

Add schema for frameEffects

Find the descriptions for frameEffects and add it as a page with schema instead of just a list

documentation: missing keys for "block" and "onlineOnly"

See mtgjson/mtgjson#54

documentation: version.json missing

In the documentation there is info about the keywords and set list file, but not the version file.

CC: @ancestral

BTW, where do I find the setlist.json and keywords.json file added in 4.1 on the webpage?

Override keyrune.css generic icon

keyrune.css is used to apply icons to sets and uses a generic icon for sets that has no icon/or accurate icon. Find a way to override this.

Link on about us page

Love what you do. I use it on my magic league tracking app. draftalot.com

Wondering how I could get a link on your about us page.

Add MYPCards to about page

As talked via discord, I would like to have my platform added to the "About Us" page.

Link: https://mypcards.com/

Allow json schemas to have markdown-like formatting

JSON schema descriptions do not have the ability to parse markdown-like formatting such as: code wrapping for examples in descriptions.

Question: Thoughts on adding Sass

The code would be cleaner to maintain and the infra shouldn't be too difficult to put in place as there's a python library already.

Instead of running pelican directly via CLI maybe it would be wrapped around a bash in addition to the Sass compiler?

Duplicated set file for download

Hi,

I found some duplicated sets here

https://mtgjson.com/v4/sets.html#

They are 4ED.json, both for Fourth Edition and Foreign Black Border, PS14.json, in San Diego Comic-Con 2014 and Salvat 2011, and CON.json, in Conflux, is responding with 404.

https://mtgjson.com/v4/json/CON.json

I hope I could contribute with this issue and thank you for the great job you'r doing :)

documentation difficult to read

Having a proper table, differentiate the lines with alternating colors or some other way of improved display would help with reading that page a lot.

Date for current version

It would be nice to see the date of release for the current version.

use common date format

On the start page there is a date given for the latest update/version.
It sais 2019 January 30 which is a very unusual way of writing a date I think?

Use the international shortform 2019-01-30 or 30th January 2019 (UK) / January 30, 2019 (US) instead?

Investigate deeper searching in to documentation

Per issue #9

We would like search linking for specific data properties.

Free vendor: https://community.algolia.com/docsearch/

documentation not up to date

A lot of the recent changes are not documented yet.

Change minimum font size on search input to 16px

Currently on mobile when focusing inside the search input the screen on some devices, namely iOS, will zoom in and cause an odd visual effect not intended.

To stop this from happening ensure that 16px is the minimum font size for inputs.

See the following link. It's also worth reading all feedback on this topic and their comments: https://stackoverflow.com/questions/2989263/disable-auto-zoom-in-input-text-tag-safari-on-iphone

Missing fields documentation

Version: 4.1.2 (2018-11-30)

Current documentation is missing following info:

• card: missing starter and side fields;
• card -> legalities: missing penny, pauper and future fields;
• set: missing isFoilOnly field.

Missing site

Add http://draft.bestiaire.org/ to about page

set page: improve with filter/search etc.

I think it would be more helpful if the set order at https://mtgjson.com/v4/sets.html would be reversed and shows the newest sets on top instead oldest. #12

Random thought:
Having order buttons, a filter/search (e.g. for set properties) or a timeline and group the sets by year etc. are several other ideas to improve the presentation and make it easier to access the information on that page.

MTGJSON logo usage

Replace the MTGJSON in the top left with the MTGJSON logo, and on the landing page remove the "About MTGJSON" header and the logo. Will free up more space on the homepage.

Create Downloads page

Reasoning:

1. Increase SEO value
2. Unify locations of downloads between /sets and /docs

AllDeckFiles and DeckLists links 404

Links from https://mtgjson.com/downloads/compiled/ point to https://mtgjson.com/json/decks/AllDeckFiles.zip and https://mtgjson.com/json/decks/DeckLists.json respectively; seems like /decks/ is the problem.