Marking it down

This commit is contained in:
Empathic Qubit 2021-11-05 10:29:35 +01:00
parent f1b23958ce
commit 1493816b31
2 changed files with 38 additions and 0 deletions

9
LICENSE.md Normal file
View file

@ -0,0 +1,9 @@
## Primary license
Copyright (c) 2021, EmpathicQubit
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# mesen-binary-monitor
This is a monitor for Mesen, intended to mimic VICE's binary monitor.
It is currently in an alpha state, and some commands are not functional or behave
incorrectly. To use it, start up Mesen as such:
Linux:
```sh
MESEN_REMOTE_HOST=127.0.0.1 MESEN_REMOTE_WAIT=1 MESEN_REMOTE_PORT=9355 MESEN_REMOTE_BASEDIR=/path/to/mesen-binary-monitor mono Mesen.exe /path/to/mesen-binary-monitor/mesen_binary_monitor.lua romfile.nes
```
Windows (CMD):
```sh
set MESEN_REMOTE_HOST=127.0.0.1
set MESEN_REMOTE_WAIT=1
set MESEN_REMOTE_PORT=9355
set MESEN_REMOTE_BASEDIR=/path/to/mesen-binary-monitor
Mesen.exe /path/to/mesen-binary-monitor/mesen_binary_monitor.lua romfile.nes
```
The options:
* `MESEN_REMOTE_HOST`: The host to listen to
* `MESEN_REMOTE_PORT`: The port to listen to
* `MESEN_REMOTE_WAIT`: If set to `1`, pause the emulator immediately and wait
for a connection.
* `MESEN_REMOTE_BASEDIR`: Must always be the base path of the script.