📹 Recording

Helper functions for capturing screenshots and recording gameplay videos from your Odyc.js games.

---

makeScreenshot

The makeScreenshot() function captures the current game screen and downloads it as an image file.

Usage

import { createGame, makeScreenshot } from 'odyc'

const game = createGame({
	// Your game configuration
})

// Take screenshot when pressing Cmd/Ctrl + S
document.addEventListener('keydown', (event) => {
	if ((event.metaKey || event.ctrlKey) && event.code === 'KeyS') {
		makeScreenshot('game-screenshot')
	}
})

// Or take a screenshot programmatically
makeScreenshot('my-game-screenshot')

📋 Parameters

• filename (string) : The filename for the downloaded screenshot file

---

startRecording

The startRecording() function begins recording the game screen and returns a function to stop the recording and save it as a video file.

Usage

import { createGame, startRecording } from 'odyc'

const game = createGame({
	// Your game configuration
})

// Start recording with keyboard shortcut (Cmd/Ctrl + R)
document.addEventListener('keydown', (event) => {
	if ((event.metaKey || event.ctrlKey) && event.code === 'KeyR') {
		const stopAndSave = startRecording()

		// Stop recording after 10 seconds
		setTimeout(() => {
			stopAndSave('gameplay-recording')
		}, 10000)
	}
})

// Or start recording programmatically
const stopAndSave = startRecording()

// Stop and save the recording
stopAndSave('my-game-recording')

📋 Return Value

The function returns a stopAndSave function:

• stopAndSave(filename: string): void : Function to stop the recording and save it as a video file with the specified filename