npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@quilicicf/ep-stats

v2.0.2

Published

Statistics parser for empires & puzzles

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

quilicicfquilicicf

Keywords

empirespuzzlesstatisticsstatsparserocr

Readme

ep-stats

Highly experimental statistics extractor for the game Empires & Puzzles (available on Android & iOS).

Disclaimer

I am not linked to small giant games (game developer) in any way.

This project is experimental and developed for the fun on my free time.

I develop it at thought-speed and only test by using it daily.

I'd be thrilled to see others use it but please don't judge me by its quality.

What it does

As a serious E&P player, I wanted to get insights into how my alliance — and its members — fares in wars and against titans.

The only summary the games gives you is an un-copiable message in the alliance chat. If you think that this is really sad, please vote up the issue raised on the game's forum.

This project takes a screenshot of the results, uses OCR to retrieve the information as text and pushes it on a GSheet.

Then you can use the front-end application to view the stats.

Sneak peek

This is what the stats look like in the application.

Alliance page

Spreadsheet look

Members page

Spreadsheet look

How it does it

This project contains a CLI tool that fetches the screenshots from Google photos API, parses them, and pushes the parsed stats on a pre-configured Google Sheet.

It uses Tesseract JS to get the information from the image and the Google Sheets API to push the stats.

The processing done on the screenshots happens in a few steps:

  • crop the title area
  • read it with OCR
  • guess the screenshot's type from the title (hits are retrieved from the CHAT, titan information from TITAN_HUNT, and war information from ALLIANCE)
  • then crop all the areas where the interesting information is and analyze them one by one to gather all the information required for the stats (these areas differ from a screenshot type to another, that's why the type is guessed first)

Before performing OCR, the images are cropped and a threshold applied using JIMP because OCR works best on black&white images.

Limitations

OS

This tool has only been tested on Linux (tried on Linux mint 17-19 and Ubuntu 18).

MacOS being Unix-based, it should be able to run it but there's no guarantee whatsoever.

I have removed all the parts that I know can cause issues on Windows but I have never tested it and I doubt it works (making a CLI tool this complex work on Windows without testing it would be a hell of a luck). Feel free to create issues if you spot a bug but I'll need someone to test it.

Screenshot size

The program currently only supports the definition 1536x2048 (iPad mini).

You can add your own profile in the folder lib/image-processing/profiles like it was done for the iPad resolution.

This implies copying the file lib/image-processing/profiles/1536x2048.js to a file named ${WIDTH}x${HEIGHT}.js and modifying the values to fit your resolution.

You also need to register it in lib/image-processing/profiles/availableProfiles.js.

More information about how to find the values here.

Pre-requisites

  • NodeJS version 10 or more
  • A Google account (I recommend using a specific one for this application for privacy reasons but you can do what you like)
  • Some patience (the installation process is a bit long)

Installation

npm install --global @quilicicf/ep-stats
# You can run the following command to make sure the installation was OK
ep-stats --help

Initialization

Google project creation

This tool requires a Google project to access Google APIs.

MAKE SURE YOU ARE CONNECTED WITH THE RIGHT GOOGLE ACCOUNT FIRST, THEN PROCEED

You can create a Google project by following the Step 1 of the Google Sheets quickstart guide.

Click on Enable the Google Sheets API and select Desktop app.

You now have a Google project with Google Sheets API activated :tada:

This is far from enough though, you'll also need at least the Google Photos API to be associated with your project and the Google Calendar API too if you want to use the holidays feature.

Add Photos and Calendar APIs

Head to the Google dev console's library page and enable the Photos and Calendar APIs.

Rename your project

The project was named Quickstart because Google's quickstart wizard created it for you. You can rename it by opening the dev console's dashboard page, clicking on the ⋮ menu icon next to you Google account's avatar and selecting Project settings.

Retrieve your credentials

When all this is done, you can download the credentials file from the credentials page. In section OAuth 2.0 Client IDs, click on the download button at the end of the line.

You can now run:

ep-stats initialize

And copy the file you just downloaded where the tool tells you to.

How to run it

Pre-requisites

You'll need to install

Create the spreadsheet

Create a google spreadsheet from your google account.

You can either create it from scratch or copy this demo sheet and edit it.

:warning: You'll need to keep this spreadsheet up-to-date when a new player joins in! Otherwise his stats won't be added. The too will just push incomplete data to the Google Sheet.

Add members

Create a sheet named Members that looks like this:

| | A | | --- | ---------------- | | 1 | Pseudo | | 2 | PseudoOfPlayer1 | | 3 | PseudoOfPlayer2 | | 4 | PseudoOfPlayer3 | | 5 | PseudoOfPlayer4 | | ... | ... | | 30 | PseudoOfPlayer30 |

Wars

Create a sheet name Wars that looks like the example below. Only create the header row, the rest will be created by the program (the second line is here to show an example of the data).

The order of the members pseudos must be the same as in the sheet Members.

| A | B | C | D | E | F | G | H | | ------------ | --------- | --------------- | --------- | ----------- | ------------------- | ------------------- | ------- | | War date | Total | Enemy score | Bonus | Members | PseudoOfPlayer1 | PseudoOfPlayer2 | ... | | 24_12 | 2456 | 3201 | ARROWS | 27 | 123 | 437 | ... |

Titans

Create a sheet name Titans that looks like the example below. Only create the header row, the rest will be created by the program (the second line is here to show an example of the data).

The order of the members pseudos must be the same as in the sheet Members.

| A | B | C | D | E | F | G | H | ... | | -------------- | --------- | -------- | --------- | --------- | ----------- | ------------------- | ------------------- | ------- | | Titan date | Total | Life | Stars | Color | Members | PseudoOfPlayer1 | PseudoOfPlayer2 | ... | | 24_12 | 1327000 | 1327000 | 6 | HOLY | 27 | 77000 | 144524 | ... |

Upgrade ep-stats

You just need to use the same command as for the installation.

npm install --global @quilicicf/ep-stats

Roadmap

DONE

| Item | Implementation date | | ------------------------------------------------------------------------------------------------------------- | ------------------- | | Add full alliance stats (only member performance was added) | 2018_12 | | Add war bonus in stats | 2018_12 | | Add war date selector | 2019_01 | | Add war enemy score in stats | 2019_01 | | Add titans page | 2019_01 | | Retrieve member's list from the GSheet | 2019_01 | | Detect defeated titans if their life can't be guessed from the screenshot (in case it was taken after defeat) | 2019_XX | | Add a demo gsheet to copy instead of long instructions | 2019_XX | | Better logs for pushed data | 2020_04 |

TODO

The order below does not indicate priority, there's no guarantee that any of this will even be done one day

  • [ ] Auto-create screenshot profiles
  • [ ] Push to npm
  • [ ] Create a post on small giant forum
  • [ ] Fail when there are more members parsed than present on the spreadsheet
  • [ ] Try to validate scores (see what's doable)