diff --git a/docs/src/content/docs/apis/launch.md b/docs/src/content/docs/apis/launch.md index fb3bf3c..7f1f76b 100644 --- a/docs/src/content/docs/apis/launch.md +++ b/docs/src/content/docs/apis/launch.md @@ -67,7 +67,7 @@ const nostalgist = await Nostalgist.launch({ **type:** `string | HTMLCanvasElement` **default:** an empty string `''` - Use this option to specify the canvas element you want to launch the emulator with. If it's an `string`, we will look up the element by `document.querySelector` + Use this option to specify the canvas element you want to launch the emulator with. If it's an `string`, we will look up the element by `document.querySelector`. If it's an empty string, a canvas element will be created automatically and this canvas element will be append to `document.body`. @@ -260,8 +260,15 @@ const nostalgist = await Nostalgist.launch({ For example, ```js - const nostalgist = await Nostalgist.launch(options) // will not launch the emulator - await nostalgist.launchEmulator() // the emulator will be started + // will not launch the emulator + const nostalgist = await Nostalgist.launch({ + core: 'fceumm', + rom: 'flappybird.nes', + runEmulatorManually: true + }) + + // the emulator will be launched + await nostalgist.launchEmulator() ``` + #### `emscriptenModule` diff --git a/docs/src/content/docs/guides/related.md b/docs/src/content/docs/guides/related.md index d023d3c..179ea49 100644 --- a/docs/src/content/docs/guides/related.md +++ b/docs/src/content/docs/guides/related.md @@ -7,7 +7,6 @@ title: Related + These are the fundamental dependencies of Nostalgist.js. + [RetroArch](https://www.retroarch.com/) and its friends(the emulators/cores) + [Emscripten](https://emscripten.org/) - + [BrowserFS](https://github.com/jvilk/BrowserFS) + We are using ROMs here for the purpose of demonstration. + [retrobrews](https://retrobrews.github.io/) and the authors of the homebrew games. diff --git a/docs/src/content/docs/guides/under-the-hood.md b/docs/src/content/docs/guides/under-the-hood.md index be55370..176765d 100644 --- a/docs/src/content/docs/guides/under-the-hood.md +++ b/docs/src/content/docs/guides/under-the-hood.md @@ -25,9 +25,7 @@ await Nostalgist.nes('https://your-server.com/roms/super-mario-bros.nes') Make sure your server have configured the CORS headers properly. ### Step two -Prepare a virtual file system. - -We use [BrowserFS](https://github.com/jvilk/BrowserFS)'s `MemoryFS` to create a virtual file system. The files loaded by step one will be written here as well. +Prepare a virtual file system. The files loaded by step one will be written here as well. ### Step three Launch RetroArch with the virtual file system and the canvas element we specified in the code. diff --git a/readme.md b/readme.md index ddce4e0..581dd84 100644 --- a/readme.md +++ b/readme.md @@ -98,7 +98,6 @@ Please refer to [nostalgist.js.org/apis](https://nostalgist.js.org/apis). + These are the fundamental dependencies of Nostalgist.js. + [RetroArch](https://www.retroarch.com/) and its friends(the emulators/cores) + [Emscripten](https://emscripten.org/) - + [BrowserFS](https://github.com/jvilk/BrowserFS) + We are using ROMs here for the purpose of demonstration. + [retrobrews](https://retrobrews.github.io/) and the authors of the homebrew games.