philipp-meier/gw2-cli

:pager: Simple neofetch-like command line tool for displaying Guild Wars 2 stats by using the official GW2 API.

gw2-cli

Simple neofetch-like command line tool for displaying Guild Wars 2 stats by using the official API.

Note: This is a learning project I set up to familiarize myself with Rust, since I did not have any prior experience with this tech stack. Feel free to contribute to this project.

Usage

Set your GW2 API-key to a environment variable named Gw2Cli_ApiKey. After that, gw2-cli can be used as described below:

Usage: gw2cli [OPTIONS] [COMMAND]

Commands:
  characters  Character information
  help        Print this message or the help of the given subcommand(s)

Options:
  -l, --lang <LANG>  [default: en]
  -h, --help         Print help information

List characters

gw2cli characters list

Character details

gw2cli characters <character_name> 

Development

Performance tests

# sudo apt install linux-tools-generic

# Stats
perf stat -r 10 ./target/release/gw2cli
# List characters
perf stat -r 10 ./target/release/gw2cli characters list

Linter

cargo clippy

Further ideas / goals

• Localizing static texts
• Achievement points (APs)
• Hall of Monuments points
• In-game currency to collect on the TP
• Number of unlocked character slots
• Available content (PoF, HoT,..)
• Different views (PvP, WvW, Rewards...) using clap arguments
• Character with the most playtime (incl. profession and specialization)
• Different ascii logos based on the main character or other statistics

gw2-cli's Issues

Improve "stats" performance

The "v2/characters/{NAME}/core" endpoint takes a long time to respond.
Since this endpoint will be called for every character to get the oldest character, the requests should be parallelized to save time.

"Age" is currently misinterpreted

"Oldest char" currently fetches the character with the most playtime ("age") and not the oldest character, which also unlocks the "oldest character"-achievements.

Solution:
Show the age as "playtime" so that it doesn't get confused with the actual age of the character, which is based on the create date.
(The official API also interprets "age" as the playtime.)