From 218e418945f3adefe3d7a851a8c60d6fdf347858 Mon Sep 17 00:00:00 2001 From: shoaib11120 Date: Tue, 7 Dec 2021 19:09:12 +0530 Subject: [PATCH] - Supports NVDA, JAWS and SAPI - Narrates/Speaks dialogues - Narrates/Speaks health and stamina on pressing `R` --- .gitattributes | 63 ++++ .gitignore | 363 +++++++++++++++++++++++ stardew-access.sln | 25 ++ stardew-access/Game/CurrentPlayer.cs | 44 +++ stardew-access/ModEntry.cs | 117 ++++++++ stardew-access/manifest.json | 10 + stardew-access/stardew-access.csproj | 23 ++ stardew-access/stardew-access.csproj.bak | 17 ++ 8 files changed, 662 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 stardew-access.sln create mode 100644 stardew-access/Game/CurrentPlayer.cs create mode 100644 stardew-access/ModEntry.cs create mode 100644 stardew-access/manifest.json create mode 100644 stardew-access/stardew-access.csproj create mode 100644 stardew-access/stardew-access.csproj.bak diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9491a2f --- /dev/null +++ b/.gitignore @@ -0,0 +1,363 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Oo]ut/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd \ No newline at end of file diff --git a/stardew-access.sln b/stardew-access.sln new file mode 100644 index 0000000..a03916b --- /dev/null +++ b/stardew-access.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31919.166 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "stardew-access", "stardew-access\stardew-access.csproj", "{8E09FAAE-94D4-4841-85FD-E1D49D4D3CBC}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {8E09FAAE-94D4-4841-85FD-E1D49D4D3CBC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8E09FAAE-94D4-4841-85FD-E1D49D4D3CBC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8E09FAAE-94D4-4841-85FD-E1D49D4D3CBC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8E09FAAE-94D4-4841-85FD-E1D49D4D3CBC}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {0D715299-364C-41CF-A926-D3F115294FDD} + EndGlobalSection +EndGlobal diff --git a/stardew-access/Game/CurrentPlayer.cs b/stardew-access/Game/CurrentPlayer.cs new file mode 100644 index 0000000..c5d563f --- /dev/null +++ b/stardew-access/Game/CurrentPlayer.cs @@ -0,0 +1,44 @@ +using StardewValley; +using StardewModdingAPI; + +namespace stardew_access.Game +{ + internal class CurrentPlayer + { + private static Farmer player = null; + + CurrentPlayer() + { + } + + private static void initPlayer() + { + player = Game1.player; + } + + public static int getHealth() + { + if(player == null) + initPlayer(); + + int maxHealth = player.maxHealth; + int currentHealth = player.health; + + int healthPercentage = (int) (currentHealth * 100)/maxHealth; + return healthPercentage; + } + + public static int getStamina() + { + if (player == null) + initPlayer(); + + int maxStamina = player.maxStamina; + int currentStamine = (int)player.stamina; + + int staminaPercentage = (int)(currentStamine * 100) / maxStamina; + + return staminaPercentage; + } + } +} diff --git a/stardew-access/ModEntry.cs b/stardew-access/ModEntry.cs new file mode 100644 index 0000000..ef61583 --- /dev/null +++ b/stardew-access/ModEntry.cs @@ -0,0 +1,117 @@ +using AccessibleOutput; +using stardew_access.Game; +using StardewModdingAPI; +using StardewModdingAPI.Events; +using StardewValley; +using HarmonyLib; + +namespace stardew_access +{ + /// The mod entry point. + public class MainClass : Mod + { + public static IAccessibleOutput screenReader; + Harmony harmony; + public static IMonitor monitor; + /********* + ** Public methods + *********/ + /// The mod entry point, called after the mod is first loaded. + /// Provides simplified APIs for writing mods. + public override void Entry(IModHelper helper) + { + // Inititalize monitor + monitor = Monitor; + + // Initialize the screen reader + initializeScreenReader(); + + // Init harmony + harmony = new Harmony(ModManifest.UniqueID); + + // Add patches + harmony.Patch( + original: AccessTools.Constructor(typeof(StardewValley.Menus.DialogueBox), new Type[] { typeof(Dialogue) }), + postfix: new HarmonyMethod(typeof(MainClass), nameof(MainClass.Dialog_post)) + ); + + harmony.Patch( + original:, + postfix: + ); + + + helper.Events.Input.ButtonPressed += this.OnButtonPressed; + } + + private static void Dialog_post(Dialogue dialogue) + { + try + { + string speakerName = dialogue.speaker.Name; + List dialogues = dialogue.dialogues; + int dialogueIndex = dialogue.currentDialogueIndex; + + screenReader.Speak($"{speakerName} said, {dialogues[dialogueIndex]}", false); + monitor.Log($"Dialogue", LogLevel.Info); + }catch (Exception e) + { + monitor.Log($"Unable to narrate dialog:\n{e.StackTrace}", LogLevel.Error); + } + } + + private void initializeScreenReader() + { + NvdaOutput nvdaOutput = null; + JawsOutput jawsOutput = null; + SapiOutput sapiOutput = null; + + // Initialize NVDA + try{ + nvdaOutput = new NvdaOutput(); + }catch(Exception ex){ + Monitor.Log($"Error initializing NVDA:\n{ex.StackTrace}", LogLevel.Error); + } + + // Initialize JAWS + try + { + jawsOutput = new JawsOutput(); + }catch (Exception ex){ + Monitor.Log($"Error initializing JAWS:\n{ex.StackTrace}", LogLevel.Error); + } + + // Initialize SAPI + try + { + sapiOutput = new SapiOutput(); + }catch (Exception ex){ + Monitor.Log($"Error initializing SAPI:\n{ex.StackTrace}", LogLevel.Error); + } + + if (nvdaOutput != null && nvdaOutput.IsAvailable()) + screenReader = nvdaOutput; + + if(jawsOutput != null && jawsOutput.IsAvailable()) + screenReader = jawsOutput; + + if (sapiOutput != null && sapiOutput.IsAvailable()) + screenReader = sapiOutput; + } + + + private void OnButtonPressed(object sender, ButtonPressedEventArgs e) + { + // ignore if player hasn't loaded a save yet + if (!Context.IsWorldReady) + return; + + // Narrate Health And Energy + if (Equals(e.Button, SButton.R)) + { + screenReader.Speak($"Health is {CurrentPlayer.getHealth()} and Stamina is {CurrentPlayer.getStamina()}"); + } + } + + } +} \ No newline at end of file diff --git a/stardew-access/manifest.json b/stardew-access/manifest.json new file mode 100644 index 0000000..4fd5751 --- /dev/null +++ b/stardew-access/manifest.json @@ -0,0 +1,10 @@ +{ + "Name": "Stardew Access", + "Author": "Mohammad Shoaib", + "Version": "1.0.0", + "Description": "", + "UniqueID": "shoaib.stardewaccess", + "EntryDll": "stardew-access.dll", + "MinimumApiVersion": "3.0.0", + "UpdateKeys": [] +} \ No newline at end of file diff --git a/stardew-access/stardew-access.csproj b/stardew-access/stardew-access.csproj new file mode 100644 index 0000000..210f6b7 --- /dev/null +++ b/stardew-access/stardew-access.csproj @@ -0,0 +1,23 @@ + + + + net452 + stardew_access + enable + enable + preview + AnyCPU + + + + + + + + + + + + + + diff --git a/stardew-access/stardew-access.csproj.bak b/stardew-access/stardew-access.csproj.bak new file mode 100644 index 0000000..08a75f1 --- /dev/null +++ b/stardew-access/stardew-access.csproj.bak @@ -0,0 +1,17 @@ + + + + net452 + stardew_access + enable + enable + preview + MainClass.ModEntry + + + + + + + +