Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MeijiRestored committed Mar 21, 2022
1 parent 3a91d46 commit 08c856c
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
stats.txt
example stats.txt
stats.txt
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Minesweeper X Stats viewer

![Release](https://img.shields.io/github/v/release/32Vache/msx-stats) ![Commit activity](https://img.shields.io/github/commit-activity/m/32Vache/msx-stats) ![Repo size](https://img.shields.io/github/repo-size/32Vache/msx-stats) &nbsp; <img src="https://raw.githubusercontent.com/32Vache/emc-map-colors/main/assets/ua.svg" width="20px">

A website to visualize [Minesweeper X](http://www.curtisbright.com/msx/)'s ``stats.txt`` file.
![Stats viewer](https://raw.githubusercontent.com/32Vache/msx-stats/main/assets/main.png)

## Usage

Open the website with [this link](https://32vache.github.io/msx-stats/) and load in your ``stats.txt`` file.

The website will then parse various stats from the file and display them.

### How to get the stats.txt file

By default, Minesweeper X does not save the ``stats.txt`` file, you have to enable it manually.

Open Minesweeper X, go in the Extras tab, open Auto Options

![Auto Options menu](https://raw.githubusercontent.com/32Vache/msx-stats/main/assets/auto-options.png)

From this menu, check 'All' under Statistics (in orange). Do the same for every game mode (in red), as the statistics setting applies per game mode.

[Stats file](https://raw.githubusercontent.com/32Vache/msx-stats/main/assets/stats-file.png)

As you play minesweeper, Minesweeper X will fill in the ``stats.txt`` file, located in the same folder as the game executabe, with various stats, that you can read here!
Binary file added assets/auto-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/stats-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 08c856c

Please sign in to comment.