OpenPunk/citra
1
0
Fork 0
mirror of https://github.com/citra-emu/citra.git synced 2024-11-30 02:50:06 +00:00
Code Issues Projects Releases Wiki Activity

Add a README.md on the script file format

Browse Source
This commit is contained in:
danzel 2017-08-13 18:02:48 +12:00
parent dc6b183837
commit c70b49be17
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/scripted_input/README.md Normal file
View File

@ -0,0 +1,35 @@
# ScriptedInput
This is a system for supplying button/pad/touch input to the emulator from a file, rather than user input.
It also supports saving screenshots of the game, so they can be compared with past behaviour.
This allows us to create reproducable test cases that utilize real games, so we can test the behaviour citra.
## Script File Format
Example
```bash
30 # first line isn't allowed buttons
10 a # get through the first menu
10
10 start # get through the second menu
10
10 [200,150] # Touch the button
10
screenshot # screenshot of second menu fading out
```
Each line starts with a number, this is how many frames to run. It is then followed by a space separated list of buttons.
Optionally a line maybe a have a comment, started with a `#` character, everything after that is ignored.
If a line starts with `screenshot` then a screenshot will be saved at that time, the file is named `{framenumber}.bmp` and saved in the current working directory.
**THE FOLLOWING ARE NOT YET IMPLEMENTED**
Touch screen input can be denoted with `[100,100]`, where the numbers are the pixel location of the touch (0-320, 0-240).
Circle pad input can be denoted with `(-1,1)`, where the numbers are the joystick location (from -1 to 1). If not specified, the circle pad will be at (0,0).
C-stick input can be denoted with `{1,-1}`, where the numbers are the joystick location (from -1 to 1). If not specified, the C-stick will be at (0,0).