Skip to content

Commit

Permalink
docs: Update documentation for new features
Browse files Browse the repository at this point in the history
  • Loading branch information
manuelseeger committed Dec 29, 2024
1 parent 5bc5cd9 commit 77fa4b4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ Set up all dependencies from `environment-cp311.yml`. Review [Installation.md](I

The OBS setup is not documented here and you can skip this part by keeping `obs_integration=False`.

More undocumented features:
More features implemented but currently not documented:
- Twitch integration, AI coach listens and responds to questions in twitch chat
- Battle.net integration, AI coach can request profile information including portrait for players from battle.net
- SC2 pulse integration, AI coach can try to unmask barcodes
Expand All @@ -247,7 +247,7 @@ Probably a lot...
- This is meant for competitives 1v1 ladder. Team games, arcade, customs are not supported and either explicidely excluded from replay processing or may cause unexpected behavior.
- Most of the internal logic relies on the name of a player(s) and thus won't work properly for a student who changes their name from season to season.
- This has only been tested with replays starting from early 2023. Much older replays will likely throw errors.
- Text mode wake event interferes with SC2 causing lag. Don't use suring gaming sessions.
- Text mode wake event interferes with SC2 causing lag. Don't use during gaming sessions.

## SC2 map stats

Expand Down

0 comments on commit 77fa4b4

Please sign in to comment.