Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Elekester committed Aug 9, 2022
1 parent 6da3408 commit 028edd7
Showing 1 changed file with 0 additions and 52 deletions.
52 changes: 0 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,59 +6,7 @@ Visit the site at: https://elekester.github.io/PSO2-Chat-Log-Statistics/

# PSO2 Chat Log Statistics User Manual

## File Upload and Settings Menu

When you first get started you'll see the below box with the file uploads and settings to choose from with an empty output below.

![Options Menu Example](images/options_menu.png)

### 1. Chat Log Files Upload

You may select any number of files in the log or log_ngs folders in your PSO2 documents directory (same place that PSO2 stores native screenshots) to upload here. Files that aren't chat logs or symbol chat logs are simply skipped.

![File Selecting Example](images/file_select.png)

### 3. Player ID Filter File Upload

The Player ID filter file is a plain text document containing numerical Player IDs separated by a new line, tab, or comma. The resutls are limited to just those players who have those Player IDs.

```
11212306,10077092, 10991589
12214386
```

### 3. Name Filter File Upload

The name filter file is a plain text document containing names separated by a new line, tab, or comma. The results are limited to just those players who have a Player ID Name or Character Name in the filter.

```
ElekesterPrime,Nel, Elekester
Nett
```

Uploading more chat log files will increase the likelihood of the name filter catching players who use multiple characters with unknown names, but may increase the time required to perform calculations.

### 4. Name Filter Sensitivity

You can specify a sensitivity setting to allow for spelling errors in the name. The setting ranges from 0, which will accept all names as equivalent, to 100, which will only count exact spelling.

At 50 for example, Nel and Neol are treated as the same name, while at 80 they'd be two different names.

### 5. Name and Player ID Filter Operation

If you wish to filter messages from players with a name in the Name Filter or an ID in the Player ID filter, set this to "Player must match Name OR Player ID." You may instead wish to filter only the messages from a set of Player IDs using a name, in which case set this to "Player must match Name AND Player ID".

### 6. Message Filter

You can filter by message content. Only messages containing the given case-insensitive text will be included in the calculation. Alternatively you can set the message filter using a regular expression (will not work on Safari).

### 7. Date Filter

The results may also be filtered by message date. By default this is set to only include messages from the past four weeks, but can be set to as early as PSO2's launch date.

### 8. Calculate Button

Hit this button to calculate the statistics for the uploaded chat logs with the given filters. The results will be displayed below in the Output, unsorted.

## Output Table

Expand Down

0 comments on commit 028edd7

Please sign in to comment.