poe_gem_parser 0.1.0

PoE gem parser written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

# PoE Gem Parser in Rust

A parser for normal gems from game "Path of Exile" written in Rust. Parser is written using `pest` library and can extract various fields(name, tags, level, requirements, etc.) of the selected gem. That project can be further extended for parsing not only gems, but also transfigured/vaal gems, items, fragments, etc. (Gem text for testing can be taken from Path of Exile's trade site)


## Description

Parser reads input string from arguments or file and splits it into components using predifined `pest` grammar rule, that components are later combined in a `ParsedGem` structure.


## Developed grammar rules

WHITESPACE - any whitespace characters  
separator - separator between blocks  
gem - complete gem grammar rule  
item_class - class of item with "Item class:" string  
class - class of item  
rarity - rarity type of item with "Rarity:" string  
rarity_type - rarity type  
name - name of item  
tags - tags of item  
level - level of gem with "Level:" and "(Max)" strings  
gem_level - level of gem  
gem_changes - stats that are changed using this gem  
quality - quality of gem with "Quality:" and "(augmented)" strings  
gem_quality - quality of gem  
requirements - requirements this gem with "Requirements:" string  
requirement - one of requirements  
description - description of the gem  
modifiers - modifiers of gem  
usage - how that gem should be used in a game  
corrupted - is item corrupted or not  
note - note  

## Example 

```
Item Class: Support Gems     --------- class = "Support Gems"
Rarity: Gem                  --------- rarity = "Gem"
Enlighten Support            --------- name = "Enlighten Support"
--------
Exceptional, Support         --------- tags = ["Exceptional", "Support"]
Level: 2                     --------- level = 2
Reservation Multiplier: 96%  --------- gem_changes = ["Reservation Multiplier: 96%"]
Quality: +9% (augmented)     --------- quality = 9
--------
Requirements:                --------- requirements = ["Level: 1"]
Level: 1                 
--------
Supports any skill gem       --------- description = "Supports any skill gem"
--------
Gains increased Experience   --------- modifiers = ["Gains increased Experience"]
--------
Experience: 1/226854909      --------- experience = "1/226854909"
--------
This is a Support Gem        --------- usage = "This is a Support Gem"
--------
Corrupted                    --------- corrupted = true
--------
Note: ~price 30 chaos        --------- note = "~price 30 chaos"
```


## Dependencies
Dependencies used in `Cargo.toml`:

```toml
pest_derive = "2.7.14"
pest = "2.7.14"
anyhow = "1.0.91"
thiserror = "2.0.3"
```