Merge pull request #62 from gurgalex/add_summoning_read

Add summoning brazier, creatures screen, reorder screen, and GodForge + perf fixes and numerous other things

Author: gurgalex

CHANGELOG.md

@@ -1,3 +1,21 @@
+# v0.11.0
+## feat
+- Certain UI Screens now give more helpful output
+  - Summoning Brazier - Reads current creature, read trait + description, copy all creature info to clipboard
+  - Creatures screen - Now tells what creature number is being interacted with for example Creature 1 Trait(s)
+  - GodForge select - Tells what creature is being selected to GodForge
+  - Reorder Creatures - Tells what creature you are selecting, and which number to swap it with
+
+## perf
+- CPU usage should be ~15-20% lower due to only scanning quests every second
+
+## fix
+- Better, Faster, Stronger, Dead quest. Phase Folk killed now works (typo in quest name)
+- Key presses are no longer read when Siralim Ultimate is the active window
+
+## Change
+- Default to not repeat sounds when stationary for new installations. Delete config.ini or set `repeat_sound_when_stationary` to false.
+
 # v0.10.3
 # fix
 - Fix broken release by pinning opencv dependency version

README.md

@@ -2,21 +2,31 @@
 
 A program to aid in making [Siralim Ultimate](https://store.steampowered.com/app/1289810/Siralim_Ultimate/) more accessible to visually impaired users.
 
-# Demo
+## Demo
 
 [![Siralim Access Video Demo of Realm Navigation and TTS](https://img.youtube.com/vi/00jdY_b_ra0/maxresdefault.jpg)](https://www.youtube.com/watch?v=00jdY_b_ra0)
 
 
-# Features
-- Integration with your screen reader of choice (NVDA, JAWS, Window-Eyes, SuperNova, System Access, ZoomText
-)
+## Features
+- Integration with your screen reader of choice
+  - NVDA
+  - JAWS
+  - Window-Eyes
+  - SuperNova
+  - System Access
+  - ZoomText
 - Sound list screen to familiarize with which sounds are for what
 - Unique audio sounds for specific items
 - Replaces game font with accessible version (Arial bold)
 - Speaks the currently selected menu item
 - Dialog boxes are spoken such as for the story, NPCs, and realm altars
+- Specialized output for certain UI screens
+  - Summoning brazier
+  - Creatures screen (know which creature's traits, artifact, spell gems are being configured)
+  - Reorder creature screen
+  - GodForge avatar select
 
-## Items sounds
+## Item sounds
 [video of sounds playing](https://youtu.be/2vVCJtCocbA)
 
 - Quest items
@@ -29,19 +39,30 @@ A program to aid in making [Siralim Ultimate](https://store.steampowered.com/app
 - Teleportation shrine
 - Summoning brazier
 
-# Required game settings
+## Keyboard Shortcuts
+| Action                    | Default Key |
+| ------------------------- | ----------- |
+| Speak secondary info      | o           |
+| Speak all available info  | v           |
+| Copy all available info   | c           |
+
+## Requirements
+
+### Game settings
 - Display Zoom: 1x - to identify any realm object
 
-# Operating System Requirements
+### Operating System Requirements
 - Windows 10 - only so far tested on 2021 releases
 - The English United States language pack must be installed [Instructions can be found here](https://support.microsoft.com/en-us/windows/install-a-language-for-windows-ccd853d3-9ecd-7da7-9ef0-72b4a055410a)
 
-
-# How to download
+## How to download
 The latest version of the installer can be found [here https://github.com/gurgalex/SiralimAccess/releases/latest](https://github.com/gurgalex/SiralimAccess/releases/latest)
 
-
-# FAQ
+## FAQ
 ## How to change the voice used if not using a screen reader?
 The SAPI voice is controlled by the Windows control panel.
 - Control Panel -> Speech Recognition -> Text to Speech -> Voice selection
+
+## Where is the config file?
+`%localappdata%\SiralimAccess`
+Edit `config.ini`

VERSION

@@ -1 +1 @@
-0.10.3
+0.11.0

assets.db

@@ -24,6 +24,7 @@ a = Analysis(['cli.py'],
              datas=[
              ('VERSION', '.'),
              ('assets.db', '.'),
+             ('subot/creatures.csv', 'subot'),
              ('resources/audio', 'resources/audio'),
              ('resources/custom_assets/NPCs/Castle', 'resources/custom_assets/NPCs/Castle'),
              ],

cli.spec

@@ -18,7 +18,7 @@ brotli==1.0.9
 urllib3==1.26.6
 
 pynput~=1.7.3
-cytolk~=0.1.7
-future~=0.18.2
+cytolk~=0.1.10
 requests~=2.26.0
 semantic-version~=2.8.5
+pyclip~=0.5.4