Correct typos found by community (#62)

This commit is contained in:
nharris-lmg
2023-10-03 14:27:48 -07:00
committed by GitHub
parent 9578f9c467
commit 17bd7a4756
19 changed files with 35 additions and 31 deletions

View File

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
Changes are grouped by the date they are merged to the main branch of the repository and are ordered from newest to oldest. Dates use the ISO 8601 extended calendar date format, i.e. YYYY-MM-DD.
## 2023-10-03
- Fix typos found by community members @TheDevMinerTV, @KikisGamingService, @seanmrice, @Intron014
## 2023-09-29
- Add readme file to the game settings directory.

View File

@@ -11,11 +11,11 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -11,11 +11,11 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -1,5 +1,5 @@
<img src="images/labs_icon.png" alt="Logo" width="100" height="56" />
<h1>Markbench Test Harnesses</h1>
<h1>MarkBench Test Harnesses</h1>
<!-- omit in toc -->
## About The Project
@@ -33,7 +33,7 @@ Most of the test harnesses are written in Python, which you will need on your sy
<!-- omit in toc -->
##### Installation
We reccomend you install python from the [official downloads page](https://www.python.org/downloads/) and not the Windows Store.
We recommend you install python from the [official downloads page](https://www.python.org/downloads/) and not the Windows Store.
#### Poetry
This project uses [Poetry](https://python-poetry.org/docs/) for dependency management.
@@ -121,7 +121,7 @@ os.system(command)
```
This is a very simple harness which takes in the arguments passed from the commandline and then executes the `FurMark.exe` test. A test harness can vary wildly in complexity depending on the test the harness is implementing. A canned game benchmark might require use of libraries like PyAutoGui to navigate around a game menu, or edit registry to setup configuration.
Harness entrypoints and any supporting files should live in a named directory in the root harness directory.
Harness entry points and any supporting files should live in a named directory in the root harness directory.
<p align="right">(<a href="#readme-top">back to top</a>)</p>

View File

@@ -15,11 +15,11 @@ Starts a new game and waits through intro sequence. Ends once the intro sequence
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -12,12 +12,12 @@ Downloads and installs the [CSGO Benchmark scripts](https://github.com/samisalre
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -11,11 +11,11 @@ Navigates menus to in-game benchmark then runs it.
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -10,6 +10,6 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -10,6 +10,6 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -14,4 +14,4 @@ Navigates menus to start a custom game.
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`

View File

@@ -13,7 +13,7 @@
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -16,7 +16,7 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -1,6 +1,6 @@
# Forza Horizon 5
This script runs RTSS with the proivded profile config and navigates through in-game menus to the built in benchmark and runs it with the current settings.
This script runs RTSS with the provided profile config and navigates through in-game menus to the built in benchmark and runs it with the current settings.
## Prerequisites
@@ -12,7 +12,7 @@ This script runs RTSS with the proivded profile config and navigates through in-
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -1,13 +1,13 @@
# Harness Utils
Harness Utils contains scripts that are loosely connected around providing helper utilities used across
mulitiple test harnesses.
multiple test harnesses.
## Keras Service
`keras_service.py`
Contains class for instancing connection to a Keras Service and provides access to it's web API.
Contains class for instancing connection to a Keras Service and provides access to its web API.
## Logging
@@ -37,4 +37,4 @@ Functions related to setting up and using RTSS configs.
`steam.py`
Functions related to using Steam for running games.
Functions related to using Steam for running games

View File

@@ -13,7 +13,7 @@ logging.getLogger("urllib3").setLevel(logging.WARNING)
DEFAULT_TIMEOUT = 120.0
class KerasService():
"""Sets up connection to a Keras serivce and provides methods to use it"""
"""Sets up connection to a Keras service and provides methods to use it"""
def __init__(
self,
ip_addr: str,

View File

@@ -10,6 +10,6 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -10,11 +10,11 @@ Starts the game, opens the in-game menu and navigates to the options menu to sta
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -11,7 +11,7 @@ This script loads the game at a specific checkpoint then waits for the scene to
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Test Setup
@@ -31,6 +31,6 @@ The test harness expects to be running from a specific checkpoint in the game, n
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds

View File

@@ -11,11 +11,11 @@ This script navigates through in-game menus to the built in benchmark and runs i
## Options
- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0`
- `kerasPort`: string representing the port of the Keras serivce. e.x. `8080`
- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
## Output
report.json
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[heigt]", e.x. `1920x1080`
- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
- `start_time`: number representing a timestamp of the test's start time in milliseconds
- `end_time`: number representing a timestamp of the test's end time in milliseconds