[Tutorial] OpenBOR - the complete guide

hansolo77

I know with my setup the way it is now, I can't even access the runcommand window without pressing L1 on my Xbox controller. If I press any other button, nothing happens. But L1? That's not supposed to be assigned to anything except navigating by pages in ES and then as a shoulder button INSIDE a game. Why is it mapped as an ENTER key for runcommand? I even have to use it as a select button when navigating inside runcommand. It's weird, and I've gotten used to it now. But it doesn't make sense. I think the joy2key "addon" is bugged.

cyperghost

@bizzar721 said in [Tutorial] OpenBOR - the complete guide:

Here are the updated Joypad configs (renamed to match your file names listed in Joypad.txt)

Uploaded them. Thank you

@hansolo77
About the joy2key tool. It is mapped to enter because of the dialog windows. DPAD is mapped to arrows direction. A is mapped to ENTER and B is TAB. This makes it impossible to use radiolists ore filemenu because therefore you need space key. That's the reason why the tools I wrote (BashROMManager, SaveStateManager....) looks so complicated. But it's the fault of the limited keymappings. But I really don't know why there are problems with mappings. Mine are working perfect with all controller types.

@BiZzAr721
Start OpenBOR and connect to SSH. type now ps -ais there a session of joy2key still present? If yes then this is faulty.

@spud11

I did find with SoRR that it has no exit key (unless you go through the menu). I wound up creating a bash script which "hard" exits SoRR which I invoke via xboxdrv

You can call Multi Switch Shutdown tool with multi_switch.sh --es-closeemu this will terminate the current emulator and will send you back to ES. I think that's rather easier then to make a fake-keypress, isn't it?

BiZzAr721

I will try things out later this evening. Since my clone image/test image still works fine, is there any specific files I should grab to compare? I already have the runcommand log and runcommand.sh on my pc to compare.

PS - appreciate being made aware of the multi switch shutdown script - thats something I see being very useful in certain situations

BiZzAr721

Here's my results:
Ran @darknior 's original openBOR call bypassing runcommand and all worked well.

Verified runcommand.sh & joy2key.py are identical on bor test image vs everyday image.
Doing ps-a it showed the bor test image was NOT running joy2key.py while the one I am having trouble with IS running joy2key.py.

Any idea on what I should do next? I don't know much about joy2key.

Edit
Joy2key is running on other ports as well, but does not exit when hitting left
On OpenBOR test image, those same ports do not show joy2key running when using ps -a

I also did not see Launch with verbose logging on the runcommand menu for OpenBOR mods

spud11

@cyperghost Thanks. I wasn't aware of this script. Is it specific to ES and might require adaptation for Attract Mode?

cyperghost

@spud11 Well as long as there is a runcommand.sh call also in Attract mode then it will work, too. But the reboot and restart things won't .... these are specfic to ES.

@BiZzAr721 So you see a running joy2key session really running if the emulator already started? It is supposed to get finished after all dialog actions are done. So after the grey box is gone away this process should be terminated by runcommand itself. That's the case in my setups and I think that's the usual way.

You can try to get PID of joy2key process by typing ps -a you see maybe the number 1234 and then with kill 1234 you can terminate this process. After this you can try if OpenBOR still finishes by pressing left DPAD key.

BiZzAr721

@cyperghost said in [Tutorial] OpenBOR - the complete guide:

You can try to get PID of joy2key process by typing ps -a you see maybe the number 1234 and then with kill 1234 you can terminate this process. After this you can try if OpenBOR still finishes by pressing left DPAD key.

Thanks, you were on the money. I killed Joy2key and then no issues! Now, at least I know the culprit. I don't want to steer this thread any more off course, so I'll open a new thread this evening. I will report the solution back here to help others. (All ports are running with joy2key, yet it seems only OpenBOR has this bug). Could run with a runcommand startup script to kill joy2key but I feel like that may open the door to a bunch of new issues.

shift

@cyperghost Thanks to your instructions I can launch all the .bor games in my folder, but there is a problem, the list shows the double titles, what is due?

cyperghost

@shift Do you mean the bash script to show list menu? Or do you see two entries in ports menu? Can you post a screenshot of this case with more explaination?

@BiZzAr721 No problem, you are welcome. You might investigate runcommand-onstart.sh maybe there is the reason why the joy2key call occours.

shift

@cyperghost said in [Tutorial] OpenBOR - the complete guide:

Do you mean the bash script to show list menu? Or do you see two entries in ports menu? Can you post a screenshot of this case with more explaination?

The bash script, the one that shows the list, but I understood where the error was. The shell extract.sh I had edited. The shell creates an empty diretory with the name "* .bor" that duplicated (I do not know why) all the games.

This is extract.sh I use now (now works well):

#!/bin/bash
PORTDIR="/opt/retropie/ports/openbor"
BORROMDIR="/home/pi/RetroPie/roms/ports/openbor"
mkdir $BORROMDIR/original/
mkdir $BORROMDIR/original/borpak/
mv $BORROMDIR/*.pak $BORROMDIR/original/
cp $PORTDIR/unpack.sh $BORROMDIR/original/
cp $PORTDIR/borpak $BORROMDIR/original/borpak/
cd $BORROMDIR/original/

for i in *.pak
do
CURRENTFILE=basename "$i" .pak
./unpack.sh "$i"
mkdir "$CURRENTFILE.bor"
mv data/ "$CURRENTFILE.bor"/
mv "$CURRENTFILE.bor"/ ../
done

for i in *.PAK
do
CURRENTFILE=basename "$i" .PAK
./unpack.sh "$i"
mkdir "$CURRENTFILE.bor"
mv data/ "$CURRENTFILE.bor"/
mv "$CURRENTFILE.bor"/ ../
done

cd $BORROMDIR/original/
rm *.pak
rm *.PAK
cd $BORROMDIR/
rmdir *.bor

echo "Your games are extracted and ready to be played."

cyperghost

@BiZzAr721 @shift I think I can quickly improve the extracting tool, too. The scripts I've seen so far a totally messed up! Please locate PAK files to /home/pi/RetroPie/roms/ports/openbor/pak

Inside this folder the pak-files will be renamed from gamename.pak to gamename.pak.originalafter extraktion.

The extract.sh below is independent now from location because borpak offers come usefull command line usage. I asked me why it was not used this way! Instead of this they copied some executables and scripts and moved whole folders... OMG!

#!/bin/bash
# PAK EXTRACT v0.65
# by cyperghost for retropie.org.uk
# 1. PLACE  BARE PAK FILES to /home/pi/RetroPie/roms/ports/openbor/pak
# 2. RUN THE SCRIPT (with user pi!)
# Change pathes as you like!

EXTRACT_BOREXE="/opt/retropie/ports/openbor/borpak"
BORROM_DIR="/home/pi/RetroPie/roms/ports/openbor"
BORPAK_DIR="$BORROM_DIR/pak"

if [[ -f $EXTRACT_BOREXE ]]; then

    mkdir -p "$BORPAK_DIR"
    cd "$BORPAK_DIR"

    for i in *.[Pp][Aa][Kk]; do
        FILE="${i%%.*}"

        if [[ $FILE == '*' ]]; then
            echo "Aborting... No files to extract in $BORPAK_DIR!"
            exit
        fi

        mkdir -p "$BORROM_DIR/$FILE.bor"
        echo "Extracting file: $i"
        echo "to dir: $BORROM_DIR/$FILE.bor"
        sleep 3
        "$EXTRACT_BOREXE" -d "$BORROM_DIR/$FILE.bor" "$i"
        echo "-------- Done Extracting: $i ---------"
        echo "-- Backup $i >> $i.original --"
        mv "$i" "$i.original"
        sleep 5
    done

    echo "Extraction done without errors!"

else

    echo "borpak executive file not found in $EXTRACT_BOREXE"
    echo "Exit now...."

fi

sleep 5

hansolo77

Is there a link or wget method to get the actual utility used in the extraction method for Linux? I've been doing it manually in Windows them moving the files over SFTP. If this extraction script works, I'd love to try it.

cyperghost

@hansolo77 wget http://raw.githubusercontent.com/crcerror/RetroPie-OpenBOR-scripts/master/extract.sh
@BiZzAr721 I've updated the script a bit ;) It works now with spaces in filenames and mixed upper/lower PAK filename

shift

@cyperghost Thank you for the script! I added the deletion of the original files because in any case I have them somewhere else.

BiZzAr721

Default OpenBor Controller Mapping

cyperghost

@bizzar721 I link this to first posting ;) Really nice

hansolo77

@bizzar721 I like this picture..Makes it very straight forward. Is this the same layout used in Streets of Rage (via RetroArch/etc)?

dishins

Hello, the PS3 controller joypad config is not working for me, controls get all funny, i have Sony Original PS3 controllers, is there any way i can sorta debug this? i tried some other input configs also but none of them are working for me.

BiZzAr721

It stays pretty consistent with Streets of Rage. I did some research when I set up Streets of Rage Remix, and this seems to be fairly similar with what people prefer.

BiZzAr721

@dishins Use a keyboard to navigate/select and remap using your controller. Is it genuine PS3 or after market? Wired or Bluetooth? When you get it a all set up we'd love it if you could upload your config to add it to the controller database. In the first post you'll find a image with the preffered controller layout.