mGBA-http v0.5.0

Setup

Download both the binary for your computer and mGBASocketServer.lua.

Which mGBA-http binary?

• If you have .NET installed download the smaller file type for your system. That is, the one without "self-contained" in the filename.
• If you do not have .NET installed, or are unsure, download the larger file type for your system. That is, the one with "self-contained" in the filename.

Need configuring?

Also download appsettings.json and put it in the same directory as mGBA-http.

For more help see the full setup guide,

Release Notes

• Large responses from mGBA are now correctly handled. Noted in issue #4, large messages were being truncated. This is because the buffer in mGBA-http for the socket work was set to 1KB and any messages larger weren't completely taken from the socket. This has been fixed and arbitrary sized returned messages now work.
  • This also surfaced in issue #3 where some requests to mGBA-http were getting data from the previous request. This has also now been resolved.
• Error handling and resilience has improved. Issue #3 is now resolved as the user and do any variation of setting up mGBA-http and mGBA and the requests will still continue to pass through correctly.
• Logging has changed in the Lua script. The new flag enableDebugLogging. defaulted to false, hides away anticipated underlying connection issues that may occur and be automatically resolved via retries.

Breaking changes

None

Other Notes

• The OSX and Linux binaries are experimental.
• The beginning of integration tests have been added

mGBA-http v0.4.0

Setup

Download both the binary for your computer and mGBASocketServer.lua.

Which mGBA-http binary?

• If you have .NET installed download the smaller file type for your system. That is, the one without "self-contained" in the filename.
• If you do not have .NET installed, or are unsure, download the larger file type for your system. That is, the one with "self-contained" in the filename.

Need configuring?

Also download appsettings.json and put it in the same directory as mGBA-http.

For more help see the full setup guide,

Release Notes

• Updated to .NET 9
• Added /coreadapter/memory
• Removed instability for /readrange calls
  • Mapped the returned result to be closer to the Lua scripting API result
• Fixed /core/readregister
• Updated docs

Breaking changes

• memorydomain/readrange now returns an array of integers
• core/readrange now returns an array of integers
• core/savestatebuffer now returns an array of integers
  • However this API is still marked as "unstable" in the implemented API docs

Other Notes

The OSX and Linux binaries are experimental.

mGBA-http v0.3.0

Setup

Download both the binary for your computer and mGBASocketServer.lua.

Which mGBA-http binary?

• If you have .NET installed download the smaller file type for your system. That is, the one without "self-contained" in the filename.
• If you do not have .NET installed, or are unsure, download the larger file type for your system. That is, the one with "self-contained" in the filename.

Need configuring?

Also download appsettings.json and put it in the same directory as mGBA-http.

For more help see the full setup guide,

Release Notes

• Moved the following hardcoded values to app.config
  • IpAddress: IP Address to connect to
  • Port: Port to connect to
  • ReadTimeout: TCP socket read timeout (in milliseconds)
  • WriteTimeout: TCP socket write timeout (in milliseconds)
• Improved connection retry logic
• Cleaner reconnections from abrupt TCP disconnects
• The many endpoints for /button now accept the button strings ("A", "Select", etc) instead of their enum integer representations
• Updated SwaggerDoc descriptions

Breaking Changes

• The /button/tapmany and /button/holdmany endpoints now accept the button strings ("A", "Select", etc) instead of their enum integer representations

Other Notes

The OSX and Linux binaries are experimental.

mGBA-http v0.2.0

Setup

Download both the binary for your computer and mGBASocketServer.lua.

Which mGBA-http binary?

• If you have .NET installed download the smaller file type for your system. That is, the one without "self-contained" in the filename.
• If you do not have .NET installed, or are unsure, download the larger file type for your system. That is, the one with "self-contained" in the filename.

Need configuring?

Also download appsettings.json and put it in the same directory as mGBA-http.

For more help see the full setup guide,

Release Notes

• Created a better custom button API to include:
  1. Tapping a button (the old button API)
  2. Tapping multiple buttons simultaneously
  3. Holding a button for a custom duration (in frames)
  4. Holding multiple buttons for a custom duration (in frames)
• The button queueing problem is fixed

Breaking Changes

• The old button API /mgba-http/button is now /mgba-http/button/tap

Other Notes

The OSX and Linux binaries are experimental.

mGBA-http v0.1.0

Setup

Download both the binary for your computer and mGBASocketServer.lua.

Which mGBA-http binary?

• If you have .NET installed download the smaller file type for your system. That is, the one without "self-contained" in the filename.
• If you do not have .NET installed, or are unsure, download the larger file type for your system. That is, the one with "self-contained" in the filename.

Need configuring?

Also download appsettings.json and put it in the same directory as mGBA-http.

For more help see the full setup guide,

Release Notes

• Initial release 🎉
• Mirrors most mGBA scripting functionality
• Custom button API for easier button sending
• Comes with Swagger.json and SwaggerUI
• Configurable ports and logging

Other Notes

The OSX and Linux binaries are experimental.