smb2-discord-payload-tasbot-esa - File README.md

smb2-discord-payload-tasbot-esa

Payload for turning Super Mario Bros 2 into a Discord chat client after achieving Arbitrary Code Execution on SMB2.

[GIT] git clone git://vigrey.com/git/smb2-discord-payload-tasbot-esa

Git Repositories

Commits

Refs

README

RSS Feed

README.md - (3173 Bytes)

 # TASBot SMB2 ACE Discord Payload
 
 Payload for turning Super Mario Bros 2 into a Discord chat client after achieving Arbitrary Code Execution on SMB2.
 
 **_TASBot SMB2 ACE Discord Payload was created by Vi Grey Vi Grey (https://vigrey.com) <vi@vigrey.com> and is licensed under the BSD 2-Clause License._**
 
 ### Description:
 This is a payload that allows TASBot to turn Super Mario Bros 2 into a Discord chat client.  This payload only uses assets from Super Mario Bros 2.  Assets are not included in this repository.
 
 ### Platforms:
 - GNU/Linux
 
 ### Build Dependencies:
 - asm6 _(You'll probably have to build asm6 from source.  Make sure the asm6 binary is named **asm** and that the binary is executable and accessible in your PATH. The source code can be found at **http://3dscapture.com/NES/asm6.zip**)_
 
 ### Build NES ROM:
 From a terminal, go to the the main directory of this project (the directory this README.md file exists in), you can then build the NES ROM with the following command.
 
     $ make
 
 The resulting NES ROM will be located at **bin/smb2-discord-payload.bin**
 
 ### Cleaning Build Environment:
 If you used `make` to build the payload binary, you can run the following command to clean up the build environment.
 
     $ make clean
 
 ### Injecting the Payload
 Once you have Arbitary Code Execution, inject this payload into CPU memory starting at $6170 and then run JMP $6200 **_(4C 00 62)_** to begin executing the payload.  This payload will be sitting inside of SRAM, so it is technically running from the cartridge itself and not just from CPU RAM.
 
 ### Controller Input Documentation
 Included in this repository is a file called DOCUMENTATION.txt, which will explain what is expected from a controller input system like TASBot for printing messages on the screen.
 
 ### License:
     Copyright (C) 2019, Vi Grey
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions
     are met:
 
         1. Redistributions of source code must retain the above copyright
            notice, this list of conditions and the following disclaimer.
         2. Redistributions in binary form must reproduce the above copyright
            notice, this list of conditions and the following disclaimer in the
            documentation and/or other materials provided with the distribution.
 
     THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS \`\`AS IS'' AND
     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     SUCH DAMAGE.