add readme for SimpleSoundManager

This commit is contained in:
Jesse Plamondon-Willard 2017-10-11 16:06:26 -04:00
parent 344058de88
commit 3e01276c56
2 changed files with 21 additions and 0 deletions

View File

@ -0,0 +1,20 @@
**SimpleSoundManager** is a [Stardew Valley](http://stardewvalley.net/) mod which lets SMAPI mods
use custom wave/sound banks for their mods. This allows for things such as playing music/sounds at
a time of day, when an object is interacted with, etc.
Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows.
## Installation
1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases).
2. Install [this mod from Nexus mods](https://www.nexusmods.com/stardewvalley/mods/1410).
3. Run the game using SMAPI.
## Usage
1. Download this mod and reference it when making your mod.
2. Create new wave/sound banks using XACT.
3. Create a new SoundManager in your mod.
4. Play sounds to your heart's content.
## Versions
1.0:
* Initial release.

View File

@ -41,6 +41,7 @@
<ItemGroup>
<None Include="manifest.json" />
<None Include="packages.config" />
<None Include="README.md" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="$(SolutionDir)\deploy.targets" />