# ptcgo-log-parser

> Module for parsing ptcgo logs

Latest version **1.0.0** (published 2021-02-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install ptcgo-log-parser
pnpm add ptcgo-log-parser
yarn add ptcgo-log-parser
bun add ptcgo-log-parser
```

## 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.0 |
| Published | 2021-02-15 |
| First published | 2021-01-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | August Dailey |
| Maintainers | theauggod |

## Links

- npm: https://www.npmjs.com/package/ptcgo-log-parser
- Repository: https://github.com/AugustDailey/Ptcgo-Log-Parser
- Homepage: https://github.com/AugustDailey/Ptcgo-Log-Parser#readme
- Issues: https://github.com/AugustDailey/Ptcgo-Log-Parser/issues
- npm.io page: https://npm.io/package/ptcgo-log-parser

## Recent versions

- 1.0.0 (latest) — 2021-02-15
- 0.1.6 — 2021-02-01
- 0.1.5 — 2021-02-01
- 0.1.4 — 2021-01-31
- 0.1.3 — 2021-01-31
- 0.1.2 — 2021-01-31
- 0.1.1 — 2021-01-31
- 0.1.0 — 2021-01-31

## README

#  Welcome to PTCGO-Log-Parser
Node.js module for quickly parsing PTCGO Game logs into a more usable json representation.
<p align="left">
  <img src="https://img.shields.io/npm/v/ptcgo-log-parser.svg?color=blue" />
  <img src="https://github.com/AugustDailey/Ptcgo-Log-Parser/workflows/PTCGO%20Log%20Parser%20CI/badge.svg" />
</p>

##  Installation

```bash

$ npm i ptcgo-log-parser

```
##  Usage

```bash

var ptcgo-parser = require('ptcgo-log-parser');

```

Read log data from a file, and parse it.

```bash

var result = ptcgo-parser.parse(data);

```
Result Json will look something like this:
```json
{
	"turns": 
	[{ 
		"number": 1, 
		"entry": "August flipped 1 coin(s), resulting in 1 heads and 0 tails, for Beginning of Game", 
		"data": 
		{
			"hasData": false,
       			"noDataString": "",
       			"source": {"CARD OBJECT"},
       			"actor": "",
       			"target": {"CARD OBJECT"}
		}
	}],
	"errors": [""],
  	"gs":
    	{ 
		"data":
		{
			"playerHand": [{"CARD OBJECT"}],
			"playerDiscard": [{"CARD OBJECT"}],
			"playerBench": [{"CARD OBJECT"}],
			"playerActivePokemon": [{"CARD OBJECT"}],
			"opponentHand": [{"CARD OBJECT"}],
			"opponentDiscard": [{"CARD OBJECT"}],
			"opponentBench": [{"CARD OBJECT"}],
			"opponentActivePokemon": [{"CARD OBJECT"}],
			"lostZone": [{"CARD OBJECT"}],
			"stadium": {"CARD OBJECT"},
			"playerDeckCount": 0,
			"playerprizeCount": 0,
			"opponentDeckCount": 0,
			"opponentPrizeCount": 0
		},
		"errors": [""]
	}
}
```
Each Card Object will have this structure:
```json
{ 
	"numberInSet": 193,
	"name": "DarkCity",
	"series": "Sun & Moon",
	"set": "Unified Minds",
	"link": "",
	"type": "TrainerCard" 
}
```

## Npm Url
https://www.npmjs.com/package/ptcgo-log-parser

## Versions
- 0.1.6 (Latest) - JSON names finalized, sample JSON provided in README.md
- 0.1.5 - Clean data for turn entries and cards
- 0.1.4 - No major feature addition. Reason for publish: Don't deploy tests to npm, just source code
- 0.1.3 - No major feature addition. Reason for publish: Don't deploy tests to npm, just source code
- 0.1.2 - No major feature addition. Reason for publish: Project source code restructure
- 0.1.1 - Parsing of game log and game state is functional
- 0.1.0 - Project initialization

##  Upcoming Features
- Card JSON Representations will include a link to their specific card entry in the Pokemon Card Database instead of only raw data. Link to database: https://www.pokemon.com/us/pokemon-tcg/pokemon-cards/
- Ability to generate PTCGO decklists from log files (Helps with discovering decks that are hidden from viewing/exporting

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