From 63bbdd2960870797f8a62e84573f500e28ec25e8 Mon Sep 17 00:00:00 2001 From: Martenfur Date: Thu, 22 Sep 2022 02:27:03 +0200 Subject: [PATCH] Updated readme and changelog. --- CHANGELOG.md | 3 +++ README.md | 26 ++++++++++++++++++- .../Content/Content.mgcb | 18 ++++++------- .../Content/Content.mgcb | 26 +++++++++---------- .../Content/Content.mgcb | 20 +++++++------- 5 files changed, 60 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 72b40cb..fe5d518 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## [Unreleased] + +## [v3.0.0] - *22.09.2022* + ### Breaking: - Renamed to FmodForFoxes. diff --git a/README.md b/README.md index c66ce44..66555f4 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ So, after you've set everything up, it's time to bop some pops, as kids say thes 3. Include the `FmodForFoxes` namespace and paste the following code into your Initialize() method: ```cs -FMODManager.Init(_nativeLibrary, FMODMode.CoreAndStudio, "Content"); +FmodManager.Init(_nativeLibrary, FMODMode.CoreAndStudio, "Content"); var sound = CoreSystem.LoadStreamedSound("test.mp3"); var channel = sound.Play(); @@ -143,6 +143,30 @@ channel.Looping = true; `_nativeLibrary` is an instance of `INativeFmodLibrary` that you have to create separately in your platform-specific projects. [Samples project](/FmodForFoxes.Samples) already has this set up. +And lastly, do note that `FmodManager` has to be properly updated and unloaded. Your main gameloop class has to have this added: + +```cs +/// +/// UnloadContent will be called once per game and is the place to unload +/// game-specific content. +/// +protected override void UnloadContent() +{ + FmodManager.Unload(); +} + +/// +/// Allows the game to run logic such as updating the world, +/// checking for collisions, gathering input, and playing audio. +/// +/// Provides a snapshot of timing values. +protected override void Update(GameTime gameTime) +{ + FmodManager.Update(); + base.Update(gameTime); +} +``` + 4. Compile and hope that you (and me) did everything right. You can also check out the incluided [Samples project](/FmodForFoxes.Samples). diff --git a/Samples/FmodForFoxes.Samples.Android/Content/Content.mgcb b/Samples/FmodForFoxes.Samples.Android/Content/Content.mgcb index b5336a9..b37209e 100644 --- a/Samples/FmodForFoxes.Samples.Android/Content/Content.mgcb +++ b/Samples/FmodForFoxes.Samples.Android/Content/Content.mgcb @@ -36,9 +36,6 @@ /processorParam:TextureFormat=Color /build:../../FmodForFoxes.Samples/Content/Gato.png;Gato.png -#begin ../../FmodForFoxes.Samples/Content/test.mp3 -/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 - #begin ../../FmodForFoxes.Samples/Content/Dialogue_CN.bank /copy:../../FmodForFoxes.Samples/Content/Dialogue_CN.bank;Dialogue_CN.bank @@ -54,9 +51,17 @@ #begin ../../FmodForFoxes.Samples/Content/Master.strings.bank /copy:../../FmodForFoxes.Samples/Content/Master.strings.bank;Master.strings.bank +#begin ../../FmodForFoxes.Samples/Content/Arial.spritefont +/importer:FontDescriptionImporter +/processor:FontDescriptionProcessor +/build:../../FmodForFoxes.Samples/Content/Arial.spritefont;Arial.spritefont + #begin ../../FmodForFoxes.Samples/Content/Music.bank /copy:../../FmodForFoxes.Samples/Content/Music.bank;Music.bank +#begin ../../FmodForFoxes.Samples/Content/test.mp3 +/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 + #begin ../../FmodForFoxes.Samples/Content/SFX.bank /copy:../../FmodForFoxes.Samples/Content/SFX.bank;SFX.bank @@ -64,9 +69,4 @@ /copy:../../FmodForFoxes.Samples/Content/Vehicles.bank;Vehicles.bank #begin ../../FmodForFoxes.Samples/Content/VO.bank -/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank - -#begin ../../FmodForFoxes.Samples/Content/Arial.spritefont -/importer:FontDescriptionImporter -/processor:FontDescriptionProcessor -/build:../../FmodForFoxes.Samples/Content/Arial.spritefont;Arial.spritefont \ No newline at end of file +/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank \ No newline at end of file diff --git a/Samples/FmodForFoxes.Samples.DesktopGL/Content/Content.mgcb b/Samples/FmodForFoxes.Samples.DesktopGL/Content/Content.mgcb index e478557..53633d6 100644 --- a/Samples/FmodForFoxes.Samples.DesktopGL/Content/Content.mgcb +++ b/Samples/FmodForFoxes.Samples.DesktopGL/Content/Content.mgcb @@ -36,9 +36,6 @@ /processorParam:TextureFormat=Color /build:../../FmodForFoxes.Samples/Content/gato.png;gato.png -#begin ../../FmodForFoxes.Samples/Content/test.mp3 -/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 - #begin ../../FmodForFoxes.Samples/Content/Dialogue_CN.bank /copy:../../FmodForFoxes.Samples/Content/Dialogue_CN.bank;Dialogue_CN.bank @@ -57,15 +54,6 @@ #begin ../../FmodForFoxes.Samples/Content/Music.bank /copy:../../FmodForFoxes.Samples/Content/Music.bank;Music.bank -#begin ../../FmodForFoxes.Samples/Content/SFX.bank -/copy:../../FmodForFoxes.Samples/Content/SFX.bank;SFX.bank - -#begin ../../FmodForFoxes.Samples/Content/Vehicles.bank -/copy:../../FmodForFoxes.Samples/Content/Vehicles.bank;Vehicles.bank - -#begin ../../FmodForFoxes.Samples/Content/VO.bank -/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank - #begin ../../FmodForFoxes.Samples/Content/Arial.spritefont /importer:FontDescriptionImporter /processor:FontDescriptionProcessor @@ -81,4 +69,16 @@ /processorParam:ResizeToPowerOfTwo=False /processorParam:MakeSquare=False /processorParam:TextureFormat=Color -/build:../../FmodForFoxes.Samples/Content/Gato.png;Gato.png \ No newline at end of file +/build:../../FmodForFoxes.Samples/Content/Gato.png;Gato.png + +#begin ../../FmodForFoxes.Samples/Content/test.mp3 +/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 + +#begin ../../FmodForFoxes.Samples/Content/SFX.bank +/copy:../../FmodForFoxes.Samples/Content/SFX.bank;SFX.bank + +#begin ../../FmodForFoxes.Samples/Content/Vehicles.bank +/copy:../../FmodForFoxes.Samples/Content/Vehicles.bank;Vehicles.bank + +#begin ../../FmodForFoxes.Samples/Content/VO.bank +/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank \ No newline at end of file diff --git a/Samples/FmodForFoxes.Samples.WindowsDX/Content/Content.mgcb b/Samples/FmodForFoxes.Samples.WindowsDX/Content/Content.mgcb index e478557..5066b47 100644 --- a/Samples/FmodForFoxes.Samples.WindowsDX/Content/Content.mgcb +++ b/Samples/FmodForFoxes.Samples.WindowsDX/Content/Content.mgcb @@ -36,9 +36,6 @@ /processorParam:TextureFormat=Color /build:../../FmodForFoxes.Samples/Content/gato.png;gato.png -#begin ../../FmodForFoxes.Samples/Content/test.mp3 -/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 - #begin ../../FmodForFoxes.Samples/Content/Dialogue_CN.bank /copy:../../FmodForFoxes.Samples/Content/Dialogue_CN.bank;Dialogue_CN.bank @@ -60,12 +57,6 @@ #begin ../../FmodForFoxes.Samples/Content/SFX.bank /copy:../../FmodForFoxes.Samples/Content/SFX.bank;SFX.bank -#begin ../../FmodForFoxes.Samples/Content/Vehicles.bank -/copy:../../FmodForFoxes.Samples/Content/Vehicles.bank;Vehicles.bank - -#begin ../../FmodForFoxes.Samples/Content/VO.bank -/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank - #begin ../../FmodForFoxes.Samples/Content/Arial.spritefont /importer:FontDescriptionImporter /processor:FontDescriptionProcessor @@ -81,4 +72,13 @@ /processorParam:ResizeToPowerOfTwo=False /processorParam:MakeSquare=False /processorParam:TextureFormat=Color -/build:../../FmodForFoxes.Samples/Content/Gato.png;Gato.png \ No newline at end of file +/build:../../FmodForFoxes.Samples/Content/Gato.png;Gato.png + +#begin ../../FmodForFoxes.Samples/Content/test.mp3 +/copy:../../FmodForFoxes.Samples/Content/test.mp3;test.mp3 + +#begin ../../FmodForFoxes.Samples/Content/Vehicles.bank +/copy:../../FmodForFoxes.Samples/Content/Vehicles.bank;Vehicles.bank + +#begin ../../FmodForFoxes.Samples/Content/VO.bank +/copy:../../FmodForFoxes.Samples/Content/VO.bank;VO.bank \ No newline at end of file