generated from nhcarrigan/template
feat: add in-game sound effects and browser notifications (#27)
Adds Web Audio API sound effects and browser notifications for key game events: achievement unlocked, quest completed, quest failed, boss defeated, prestige, transcendence, and apotheosis. Both features are toggled via profile settings, with notification permission requested on first enable.
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
/**
|
||||
* @file Browser notification utilities.
|
||||
* @copyright nhcarrigan
|
||||
* @license Naomi's Public License
|
||||
* @author Naomi Carrigan
|
||||
*/
|
||||
|
||||
/**
|
||||
* Requests browser notification permission from the user.
|
||||
* @returns Whether permission was granted.
|
||||
*/
|
||||
const requestNotificationPermission = async(): Promise<boolean> => {
|
||||
if (typeof Notification === "undefined") {
|
||||
return false;
|
||||
}
|
||||
if (Notification.permission === "granted") {
|
||||
return true;
|
||||
}
|
||||
if (Notification.permission === "denied") {
|
||||
return false;
|
||||
}
|
||||
const permission = await Notification.requestPermission();
|
||||
return permission === "granted";
|
||||
};
|
||||
|
||||
/**
|
||||
* Sends a browser notification if permission has been granted.
|
||||
* @param title - The notification title text.
|
||||
* @param body - The notification message displayed below the title.
|
||||
*/
|
||||
const sendNotification = (title: string, body: string): void => {
|
||||
if (
|
||||
typeof Notification === "undefined"
|
||||
|| Notification.permission !== "granted"
|
||||
) {
|
||||
return;
|
||||
}
|
||||
try {
|
||||
// eslint-disable-next-line no-new -- Notification constructor has side effects
|
||||
new Notification(title, { body: body, icon: "/favicon.ico" });
|
||||
} catch {
|
||||
// Silently ignore — notifications may fail silently
|
||||
}
|
||||
};
|
||||
|
||||
export { requestNotificationPermission, sendNotification };
|
||||
@@ -0,0 +1,110 @@
|
||||
/**
|
||||
* @file Sound effect utilities using the Web Audio API.
|
||||
* @copyright nhcarrigan
|
||||
* @license Naomi's Public License
|
||||
* @author Naomi Carrigan
|
||||
*/
|
||||
|
||||
type SoundEvent =
|
||||
| "achievement"
|
||||
| "apotheosis"
|
||||
| "bossVictory"
|
||||
| "prestige"
|
||||
| "questCompleted"
|
||||
| "questFailed"
|
||||
| "transcendence";
|
||||
|
||||
interface SoundPattern {
|
||||
frequencies: Array<number>;
|
||||
gain: number;
|
||||
noteDuration: number;
|
||||
type: OscillatorType;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention -- intentional constant name
|
||||
const SOUND_PATTERNS: Record<SoundEvent, SoundPattern> = {
|
||||
achievement: {
|
||||
frequencies: [ 523, 659, 784, 1047 ],
|
||||
gain: 0.3,
|
||||
noteDuration: 0.12,
|
||||
type: "triangle",
|
||||
},
|
||||
apotheosis: {
|
||||
frequencies: [ 1047, 880, 784, 659, 523 ],
|
||||
gain: 0.35,
|
||||
noteDuration: 0.25,
|
||||
type: "sine",
|
||||
},
|
||||
bossVictory: {
|
||||
frequencies: [ 523, 784, 1047 ],
|
||||
gain: 0.4,
|
||||
noteDuration: 0.18,
|
||||
type: "square",
|
||||
},
|
||||
prestige: {
|
||||
frequencies: [ 392, 523, 659, 784 ],
|
||||
gain: 0.35,
|
||||
noteDuration: 0.15,
|
||||
type: "sawtooth",
|
||||
},
|
||||
questCompleted: {
|
||||
frequencies: [ 523, 659 ],
|
||||
gain: 0.25,
|
||||
noteDuration: 0.15,
|
||||
type: "sine",
|
||||
},
|
||||
questFailed: {
|
||||
frequencies: [ 392, 330, 261 ],
|
||||
gain: 0.25,
|
||||
noteDuration: 0.18,
|
||||
type: "triangle",
|
||||
},
|
||||
transcendence: {
|
||||
frequencies: [ 261, 329, 392, 523 ],
|
||||
gain: 0.3,
|
||||
noteDuration: 0.3,
|
||||
type: "sine",
|
||||
},
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/init-declarations -- lazily initialised on first use
|
||||
let audioContext: AudioContext | undefined;
|
||||
|
||||
const getAudioContext = (): AudioContext => {
|
||||
if (audioContext === undefined) {
|
||||
audioContext = new AudioContext();
|
||||
}
|
||||
return audioContext;
|
||||
};
|
||||
|
||||
/**
|
||||
* Plays a sound effect for a given game event using the Web Audio API.
|
||||
* @param event - The game event to play a sound for.
|
||||
*/
|
||||
const playSound = (event: SoundEvent): void => {
|
||||
try {
|
||||
const context = getAudioContext();
|
||||
const pattern = SOUND_PATTERNS[event];
|
||||
for (const [ index, frequency ] of pattern.frequencies.entries()) {
|
||||
const oscillator = context.createOscillator();
|
||||
const gainNode = context.createGain();
|
||||
oscillator.connect(gainNode);
|
||||
gainNode.connect(context.destination);
|
||||
oscillator.type = pattern.type;
|
||||
oscillator.frequency.value = frequency;
|
||||
const noteOffset = index * pattern.noteDuration;
|
||||
const startTime = context.currentTime + noteOffset;
|
||||
const endTime = startTime + pattern.noteDuration;
|
||||
gainNode.gain.setValueAtTime(0, startTime);
|
||||
gainNode.gain.linearRampToValueAtTime(pattern.gain, startTime + 0.01);
|
||||
gainNode.gain.linearRampToValueAtTime(0, endTime);
|
||||
oscillator.start(startTime);
|
||||
oscillator.stop(endTime);
|
||||
}
|
||||
} catch {
|
||||
// Silently ignore — audio may not be available in all environments
|
||||
}
|
||||
};
|
||||
|
||||
export type { SoundEvent };
|
||||
export { playSound };
|
||||
Reference in New Issue
Block a user