BenMakesGames.PlayPlayMini.BeepBoop 0.6.0

Prefix Reserved
dotnet add package BenMakesGames.PlayPlayMini.BeepBoop --version 0.6.0                
NuGet\Install-Package BenMakesGames.PlayPlayMini.BeepBoop -Version 0.6.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BenMakesGames.PlayPlayMini.BeepBoop" Version="0.6.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BenMakesGames.PlayPlayMini.BeepBoop --version 0.6.0                
#r "nuget: BenMakesGames.PlayPlayMini.BeepBoop, 0.6.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BenMakesGames.PlayPlayMini.BeepBoop as a Cake Addin
#addin nuget:?package=BenMakesGames.PlayPlayMini.BeepBoop&version=0.6.0

// Install BenMakesGames.PlayPlayMini.BeepBoop as a Cake Tool
#tool nuget:?package=BenMakesGames.PlayPlayMini.BeepBoop&version=0.6.0                

What Is It?

An extension for PlayPlayMini which adds methods for generating wave forms on the fly, with support for attack and decay.

This library is in the early stages of development, and has some known issues (for example, it refuses to play notes after a while, for reasons which are still unclear to me). It is not suitable for use in a final product.

Buy Me a Coffee at ko-fi.com

How to Use

Here is an example PlayPlayMini game state which lets users play notes by pressing keys on their keyboard:

using System.Diagnostics;
using BenMakesGames.PlayPlayMini;
using BenMakesGames.PlayPlayMini.BeepBoop;
using BenMakesGames.PlayPlayMini.Services;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Input;

namespace BeepBoopTest.GameStates;

public sealed class Playing: GameState
{
    private KeyboardManager Keyboard { get; }
    private SoundManager Sounds { get; }
    private GraphicsManager Graphics { get; }

    private WaveType WaveType { get; set; } = WaveType.Square;

    private List<char> NoteHistory { get; } = new();

    public Playing(KeyboardManager keyboard, SoundManager sounds, GraphicsManager graphics)
    {
        Keyboard = keyboard;
        Sounds = sounds;
        Graphics = graphics;
    }

    public override void Draw(GameTime gameTime)
    {
        Graphics.Clear(Color.Black);

        // assumes you have loaded a font called "Font"; if not, comment these lines out
        Graphics.DrawText("Font", 2, 2, "Press A, S, D, F, G, H, J, K, L to play notes.", Color.White);
        Graphics.DrawText("Font", 2, 12, "Press 1, 2, 3, 4 to select wave shape.", Color.White);
        Graphics.DrawText("Font", 2, 22, $"Current wave shape: {WaveType}.", Color.White);
        
        for(int i = 0; i < NoteHistory.Count; i++)
            Graphics.DrawText("Font", 2 + (i * 6), 42, NoteHistory[i], i == NoteHistory.Count - 1 ? Color.White : Color.SkyBlue);
    }

    public override void Input(GameTime gameTime)
    {
        if(Keyboard.PressedKey(Keys.D1))
            WaveType = WaveType.Square;
        else if(Keyboard.PressedKey(Keys.D2))
            WaveType = WaveType.Sawtooth;
        else if(Keyboard.PressedKey(Keys.D3))
            WaveType = WaveType.Triangle;
        else if(Keyboard.PressedKey(Keys.D4))
            WaveType = WaveType.Sine;
        
        if(Keyboard.PressedKey(Keys.A)) PlaySound(Note.C);
        if(Keyboard.PressedKey(Keys.S)) PlaySound(Note.D);
        if(Keyboard.PressedKey(Keys.D)) PlaySound(Note.E);
        if(Keyboard.PressedKey(Keys.F)) PlaySound(Note.F);
        if(Keyboard.PressedKey(Keys.G)) PlaySound(Note.G);
        if(Keyboard.PressedKey(Keys.H)) PlaySound(Note.A);
        if(Keyboard.PressedKey(Keys.J)) PlaySound(Note.B);
        if(Keyboard.PressedKey(Keys.K)) PlaySound(Note.C, 5);
    }
    
    private void PlaySound(Note note, int octave = 4)
    {
        NoteHistory.Add(note.ToString()[0]);

        if(NoteHistory.Count > 40)
            NoteHistory.RemoveAt(0);
        
        var options = new WaveOptions()
        {
            Duration = 0.5f,
            AttackDuration = 0.1f,
            DecayDuration = 0.1f,
        };
        
        var sound = WaveType switch
        {
            WaveType.Square => WaveGenerator.Square(note, octave, options),
            WaveType.Sawtooth => WaveGenerator.Sawtooth(note, octave, options),
            WaveType.Triangle => WaveGenerator.Triangle(note, octave, options),
            WaveType.Sine => WaveGenerator.Sine(note, octave, options),
            _ => throw new UnreachableException()
        };
        
        Sounds.PlayWave(sound);
    }
}

enum WaveType
{
    Square,
    Sawtooth,
    Triangle,
    Sine
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.0 124 8/17/2024
0.5.1 109 5/28/2024
0.5.0 125 5/24/2024
0.4.0 246 11/25/2023
0.3.0 126 9/17/2023
0.2.1 188 6/30/2023
0.2.0 195 4/16/2023
0.1.1 247 12/11/2022
0.1.0 209 12/11/2022