Repository files navigation

GBA emulator on your React project - easy and powerful to use!

Just three steps to set it up ✨

1 - ApplyGbaProvider

import{GbaProvider}from'react-gbajs'constApp=()=>(<GbaProvider>    ...</GbaProvider>)

2 - Getplay function fromGbaContext and call it with the game ROM

import{useContext}from'react'import{GbaContext}from'react-gbajs'constButtonStartEmulator=()=>{const{    play,}=useContext(GbaContext)conststartEmulator=()=>{constgameRom=getGameRom()play({newRomBuffer:gameRom})}return(<buttononClick={()=>startEmulator()}>      Start Emulator</button>)}

3 - And render the emulator using the default export

importReactGbaJsfrom'react-gbajs'constEmulator=()=>(<ReactGbaJs/>)

Done! 🎉
Check a full example in/sample.

This package is a React wrapper forGBA.js.

GBA.js is vendored, with new features over the original version:

• save and restore state
• freeze address with a given value

klo-gba.js, level editor forKlonoa: Empire of Dreams

Add your project here

GbaContext exports the following properties:

Use this function to start or restart the emulator.

Pass atnewRomBuffer the game's ROM to load it:

play({newRomBuffer:myGameRom})

You can also fill the propertyrestoreState to restore to a previous state saved usingsaveState. If both are present, the emulator will be reset loading the ROM, and then restored to the given state:

play({newRomBuffer:myGameRom,restoreState:someState})

If you pass onlyrestoreState, the previous ROM will be re-loaded and will start on the given state. If there is no ROM previously loaded, it won't work.

play({restoreState:someState})

Return the serializable state of the emulator.

Freeze an address with the given value.

Remove the freeze value on the given address.

Return the list of the addresses frozen in the following format:

{[addressinnumber]:{size:8|16|32,value:number}}

<ReactGbaJs /> has the following props:

Should be a number between0 (default, muted) or1 (max volume).

Callback called every time that an FPS is reported.

Set the emulator scale. Default value is1, which has width 240px and height 160px.

Callback called every time that a log is received within the levels set astrue by the propwatchLogLevels.

Set when the callbackonLogReceived should be called. By default the value is{ error: true }.

1 - Clone this repository

> git clone git@github.com:macabeus/react-gbajs.git> cd react-gbajs

2 - Install its dependencies

> npm i

3 - Build and watch the project

> npm run start

4 - In another terminal window, go to the/sample project, install its dependencies, and then build and watch it

> cd sample> npm i> npm run start

Finished! Now you can develop the package and test it in real-time 🎉

@endrift for GBA.js.
@felix.rodent for the logo.