PyLNP manifest and Readme

Author: Algorithman

README.html

@@ -1,21 +1,53 @@
-# SoundCenSe
+# SoundCenSe v1.4.0 #
 
-Based on ZweiStein's SoundSense, this is a c# port to get rid of installing java on windows systems.
+SoundCenSe is a audio engine for Dwarf Fortress based on ZweiStein's SoundSense written in c#/gtk.
 
-Using the [fmod audio](http://fmod.org "fmod audio") libraries by Firelight Technologies there is now full volume control for all sound channels.
+**System requirements:**
 
-*System requirements:*
+Windows:
 
-- Mono or .NET 4.0 (depending on your OS)
-- a sound card
-- Dwarf Fortress
-- Fun
+- .NET 4.0 ([https://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe](https://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe))
+- GTK-Sharp ([http://download.xamarin.com/GTKforWindows/Windows/gtk-sharp-2.12.38.msi](http://download.xamarin.com/GTKforWindows/Windows/gtk-sharp-2.12.38.msi))
+- Microsoft Visual c++ runtime redistributables 2013 ([https://download.microsoft.com/download/3/8/7/387A0F10-C0C1-4C74-82A9-4BB741342366/vcredist_x86.exe](https://download.microsoft.com/download/3/8/7/387A0F10-C0C1-4C74-82A9-4BB741342366/vcredist_x86.exe))
 
+If it doesn't seem to start, please check the Log.txt, there might be clues to what is missing.
 
-On windows you have to install the gtk-sharp libraries ([http://www.mono-project.com/download/#download-win](http://www.mono-project.com/download/#download-win)).
-On linux or OSX apparently the mono framework (successfully tested on a debian with mono version 3.28) and the gtk libraries are needed.
 
-Memory footprint is around 30-45 MB, cpu load around 1.5% on a 4-core AMD phenom II X4 @ 3.2GHz.
+Linux:
+
+- mono-complete
+- gtk-sharp2
+
+Don't know for sure for OSX, but mono and gtk-sharp should do the trick.
+
+
+**Usage:**
+
+Just start the SoundCenSeGTK.exe (linux users without binutils fix need to use 'mono SoundCenSe.exe').
+
+## First start: ##
+
+Since no sound files are provided in this download, you need to update the sound packs first or point the Soundpack Path to the appropriate folder.
+More on that below
+
+## The audio tab ##
+On the audio tab you see the different channels (SFX, music, weather, swords and trading).
+On the right side of each of the channels you have a volume and a mute control. Changes are save on closing SoundCenSe.
+
+On the bottom of each channel you can show/hide the last 5 played sounds, which you can disable with the little button on the left side. Once you disabled a sound, it will not be played anymore until you remove it again from the *Disabled Sounds* tab, by again clicking the little button on the left side.
+
+## The update tab ##
+By clicking *Update Soundpack* the chosen soundpack folder will be checked and updated accordingly.
+Please wait for the update to finish until you start Dwarf Fortress.
+
+## The configuration tab ##
+First, there is the path to the soundpack folder. Click on the ... button to change it.
+
+Windows users have an additional checkbox for auto-detection of dwarf fortress or static path to the gamelog.
+If you choose to use a static path, you can click the ... button to change the folder.
+
+## The credits tab ##
+Especially pay attention to this tab, since without these guys, there wouldn't be a SoundCenSe at all.
 
 
 
@@ -26,3 +58,5 @@ Credits:
 - ZweiStein for his good work on SoundSense
 - jecowa for his efforts on OSX testing
 
+
+Last changed: 8/13/2016 6:45:56 PM 

README.md

@@ -122,6 +122,17 @@
     <None Include="libfmod.so">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="manifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="..\..\README.md">
+      <Link>README.md</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="..\..\README.html">
+      <Link>README.html</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Enums\" />

SoundCenSe GTK/SoundCenSeGTK/SoundCenSeGTK.csproj

@@ -0,0 +1,10 @@
+{
+    "author": "Algorithman",
+    "content_version": "1.4.0",
+    "df_min_version": "0.34.11",
+    "df_max_version": "",
+    "title": "SoundCenSe GTK",
+    "tooltip": "A c# audio engine for Dwarf Fortress based on Zweistein's SoundSense",
+	"win_exe": "SoundCenSeGTK.exe",
+	"readme": "README.html"
+}