Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zxeltor authored Sep 28, 2024
1 parent 34c3012 commit 46b93da
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# STO Real-Time Combat Overlay [![GitHub release (latest by date)](https://img.shields.io/github/v/release/zxeltor/zxeltor.StoCombat.Realtime)](https://github.com/zxeltor/zxeltor.StoCombat.Realtime/releases/latest)
# Star Trek Online Real-Time Combat Overlay [![GitHub release (latest by date)](https://img.shields.io/github/v/release/zxeltor/zxeltor.StoCombat.Realtime)](https://github.com/zxeltor/zxeltor.StoCombat.Realtime/releases/latest)

An application which tracks Star Trek Online combat data in real-time, and awards the player with Unreal Tournament style achievements.

Expand Down Expand Up @@ -45,13 +45,17 @@ You can do the following in the main UI:
![Overlays](https://github.com/zxeltor/zxeltor.StoCombat.Realtime/blob/master/ScreenShots/grid_overlay.png)
**Figure:** The main grid overlay displayed in the upper right of the screen.

**Note:** In order for the Grid Overlay to work in STO, the game needs to be running in a Window display mode

The grid overlay is what displays the combat statistics grid. Each player in combat is displayed in the grid.
The main UI has a settings tab so the user can select which statistics to display in the grid, what colors to use, and its location on the screen.

### Achievements System and Overlay
![Overlays](https://github.com/zxeltor/zxeltor.StoCombat.Realtime/blob/master/ScreenShots/doublekill_overlay.png)
**Figure:** The DOUBLE KILL achievement being flashed to the screen.

**Note:** In order for the Achievments overlay to work in STO, the game needs to be running in a Window display mode

The achievements system maintains a list of units attacked by the player while in combat. Each unit killed by the player is counted as a kill. When the player reaches certain consecutive kill achievements, a message is displayed to the screen, along with audio file playback from the Unreal Tournament Announcer.

Your consecutive kill count is reset after you've been out of combat for a configured amount of time, or when your player dies. This puts you back at the bottom of the achievement list.
Expand Down

0 comments on commit 46b93da

Please sign in to comment.