[Tutorial] OpenBOR - the complete guide

mediamogul

Glad to hear this worked out.

cyperghost

@hansolo77 glad you got it working. Are these the complete scripts? I think the method is solid ground for others.

And yes you are right for a device driver like xboxdrv the & is essential because it have to be active in background but for cp or mv command it is not needed.

The && method is useful
It is working like
mv devive1 to path
&& means true chain connection

So if device 1 is not available it will stop moving the other devices that come next in the && chain. The code could be refined but the method you elaborated is really great. That's the hard work you did - the bit of scripting fingetricks is now easy to do.

hansolo77

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

@hansolo77 glad you got it working. Are these the complete scripts? I think the method is solid ground for others.

Not entirely. In my particular set up, I'm using numerous entries in the runcommand-onstart.sh script. However, for the purpose of completeness, should somebody want to copy my working script, I can post it. The working bits of OpenBOR is all I'm including, along with the the additions of the SEGA mapping and the moving out of the NES controllers:

/opt/retropie/configs/all/runcommand-onstart.sh

if [ "$1" = "openbor" ]
then
sudo mv /dev/input/event0 ~/inputs/event0 && sudo mv /dev/input/event1 ~/inputs/event1
sudo /opt/retropie/supplementary/xboxdrv/bin/xboxdrv > /dev/null 2>&1 \
    --evdev /dev/input/by-id/usb-©Microsoft_Xbox_360_Wireless_Receiver_for_Windows_E1594E70-event-joystick \
    --detach-kernel-driver \
    --silent \
    --force-feedback \
    --deadzone-trigger 15% \
    --deadzone 4000 \
    --mimic-xpad \
    --dpad-as-button \
    --evdev-absmap ABS_X=x1,ABS_Y=y1,ABS_RX=x2,ABS_RY=y2,ABS_Z=lt,ABS_RZ=rt \
    --evdev-keymap BTN_SOUTH=a,BTN_EAST=b,BTN_NORTH=x,BTN_WEST=y,BTN_TL=lb,BTN_TR=rb,BTN_THUMBL=tl,BTN_THUMBR=tr,BTN_MODE=guide,BTN_SELECT=back,BTN_START=start,BTN_TRIGGER_HAPPY3=du,BTN_TRIGGER_HAPPY4=dd,BTN_TRIGGER_HAPPY1=dl,BTN_TRIGGER_HAPPY2=dr \
    --ui-buttonmap x=KEY_F,a=KEY_A,b=KEY_D,lb=KEY_Z,Y=KEY_S,rb=KEY_X \
    --ui-buttonmap guide=KEY_F12,start=KEY_ENTER,back=KEY_ESC \
    --ui-buttonmap du=KEY_UP,dd=KEY_DOWN,dl=KEY_LEFT,dr=KEY_RIGHT \
&
sudo /opt/retropie/supplementary/xboxdrv/bin/xboxdrv > /dev/null 2>&1 \
    --evdev /dev/input/by-id/usb-Mayflash_Ltd_Mayflash_MD_USB_Adapter-event-joystick \
    --detach-kernel-driver \
    --mimic-xpad \
    --evdev-absmap ABS_HAT0X=x1,ABS_HAT0Y=y1 \
    --evdev-keymap BTN_TR=back,BTN_TR2=start \
    --evdev-keymap BTN_SOUTH=x,BTN_EAST=a,BTN_C=b \
    --evdev-keymap BTN_NORTH=lb,BTN_WEST=y,BTN_TL=rb \
    --dpad-as-button \
    --ui-axismap x1=KEY_LEFT:KEY_RIGHT,y1=KEY_DOWN:KEY_UP \
    --ui-buttonmap y=KEY_S,b=KEY_D,a=KEY_A,lb=KEY_Z,x=KEY_F,rb=KEY_X,start=KEY_ENTER,back=KEY_ESC \
&
sudo /opt/retropie/supplementary/xboxdrv/bin/xboxdrv > /dev/null 2>&1 \
    --evdev /dev/input/by-id/usb-Mayflash_Ltd_Mayflash_MD_USB_Adapter-if01-event-joystick \
    --detach-kernel-driver \
    --mimic-xpad \
    --evdev-absmap ABS_HAT0X=x1,ABS_HAT0Y=y1 \
    --evdev-keymap BTN_TR=back,BTN_TR2=start \
    --evdev-keymap BTN_SOUTH=x,BTN_EAST=a,BTN_C=b \
    --evdev-keymap BTN_NORTH=lb,BTN_WEST=y,BTN_TL=rb \
    --dpad-as-button \
    --ui-axismap x1=KEY_G:KEY_H,y1=KEY_J:KEY_I \
    --ui-buttonmap x=KEY_N,a=KEY_K,b=KEY_M,lb=KEY_P,y=KEY_O,rb=KEY_Q \
    --ui-buttonmap start=KEY_KP9,back=KEY_KP0 \
&
fi

Provided you have XBOXDRV installed, this will create a mapping of an Xbox 360 controller as well as a Mayflash Sega Genesis Adapter (2 Players / 6-button) to keyboard keys. These keys are the default keyboard mapping inside OpenBOR, so it removes the necessary requirements of create a "master" keymap, and the need to have one for new games. This script will also move out the NES Controllers (provided by the Raphnet NES adapter) to a temporary location so OpenBOR doesn't detect it and cause the game engine to crash.

/opt/retropie/configs/all/runcommand-onend.sh

sudo killall > /dev/null 2>&1 xboxdrv

if [ "$1" = "openbor" ]
then
sudo mv ~/inputs/event0 /dev/input/event0 && sudo mv ~/inputs/event1 /dev/input/event1
fi

This script will unload the XBOXDRV driver, making your controllers work like regular controllers again without being mapped to keyboard keys. If the game system that was just running was OpenBOR, it also returns the Raphnet NES controller devices back to their original locations to be available to the system again.

EDIT Sorry, when I first ran through this, I had the script mapping the NES controllers, not the SEGA ones. So the script was not helpful. After switching it over to the SEGA ones, I discovered my maps were all wrong. Then the engine kept crashing. I fixed it all now. The current script works. If you don't have NES or SEGA controllers, you don't need to include those parts, and you don't need to include the added if segment to the runcommand-onend.sh script either. Also, mappings for Player 2 don't exist for keyboard. So you have to map them in-game first. I have it mapped for the Sega Controllers right now, but just because I don't have a 2nd XBOX controller to test with.

AtTheArcade

Thanks for the guide! I spent hours trying to figure this out on my own and was finally able to get things working after following this guide!

One question though, I have the ES background music script running and for some reason it doesn't turn off when I run OpenBOR games. I've opened up the script and looked in line 25 for the list of emulators that are supposed to pause the script and "openbor" is listed there. I started up a game, went into SSH, typed "top" and saw that the emulator name was "OpenBOR" and figured that maybe I needed to add in a variant of openbor with that casing but that didn't work either. Not really sure what else to try. Any ideas?

AtTheArcade

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

Thanks for the guide! I spent hours trying to figure this out on my own and was finally able to get things working after following this guide!

One question though, I have the ES background music script running and for some reason it doesn't turn off when I run OpenBOR games. I've opened up the script and looked in line 25 for the list of emulators that are supposed to pause the script and "openbor" is listed there. I started up a game, went into SSH, typed "top" and saw that the emulator name was "OpenBOR" and figured that maybe I needed to add in a variant of openbor with that casing but that didn't work either. Not really sure what else to try. Any ideas?

Turns out I just needed to restart ES after I updated the script. It's always something simple with me...

BiZzAr721

@AtTheArcade Glad you got it sorted out using one of the most forgotten, yet one of the most successful troubleshooting steps! Enjoy!

Winklepicker

I'm getting very confused, so what I do is on emulationstation I press F4 and then type this?

wget "http://raw.githubusercontent.com/crcerror/RetroPie-OpenBOR-scripts/master/OpenBOR - Beats of Rage Engine Selection.sh" -O "/home/pi/RetroPie/roms/ports/OpenBOR - Beats of Rage Engine Selection.sh"

I tried it, but nothing happens. What did I do wrong? is this the correct way, or the easiest best way to do it?
Sorry for the dumb question but I'm abit confused as to how to get this working.

If someone out there could make a complete video tutorial step by step it would be so much easier, it really would...
Please can someone make a video how to set this up?

As I think what is holding people back (like me who are not experts in using our pi's) from trying this emulator is the install method. how to get it installed.

therexershow

Can anyone assist me. I'm trying to open a Double Dragon Revenge modded game that works on my pc, I'm having trouble on my RPi 3B+. I load OpenBor via experimental packages. I add the .pak to the operbor folder. i run the extract.sh command. Everything seems to go ok, but when the lauch window comes up with the game, i get a quick "Loading" then exits right to the "PORTS" RPi menu screen. No idea where i went wrong.
THanks for any help.

cyperghost

@therexershow Please follow topic OpenBOR - OpenBeta

fredcobain

@cyperghost , your work is amazing! Thank you so much for that.

A strange issue always happening: every time I press "left stick" / "d-pad left" on a controller (tried using the Xbox wired controller and mk_arcade_joystic) when I am inside a game, the game quits suddenly (abnormal end) and trows me back to ES MENU. This happens anytime in the game (even when I'm trying to configure the controller).

So, I am unable to use or configure joysticks (unless I don't tap the left - what is very annoying).

Any clue of what is causing that issue ?

P.s: I'm using the latest version of RetroPie (4.6 buster image) installed on a 3b+.

Thanks in advance!

cyperghost

@fredcobain Yes I think I faced the same problem somewhere ... But I can't remember what it was :(

fredcobain

@cyperghost my hope now is in you again, please scan your memories hahaha

I'm to close to achieve my goal to play OpenBor using my Arcade Joysticks!

Is there anything I must upload to help you to remember what could be the root cause of that issue?

Thank you so much for your attention

fredcobain

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

@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.

Jesus!!! I found it!

I really killed the joy2key.py in a putty terminal after the game loads and the issue is gone!

Should we add a kill command into the Engine Selection Script ?

cyperghost

@fredcobain Oh good research ;)

Engine Selection Script...?

I don't know what you are talking about.... Usually the joy2key.py should be killed after the grey box vanishes and I think it's fixed in latest versions.

I think you can set a command pkill joy2key.py in runcommand-onstart.sh. I surly wrote a small hack down the thread you've found.

fredcobain

@cyperghost by the "Engine Selection Script" I am referring to: http://raw.githubusercontent.com/crcerror/RetroPie-OpenBOR-scripts/master/OpenBOR - Beats of Rage Engine Selection.sh"

It is the script I am using to navigate through the extracted pak files. Does this script is outdated? Do you have a newer version of that?

My solution: I just inserted a "killall joy2key.py" at the very beginning and another one at the end of that script and everything is running perfect now. (sorry about the lack of elegance in my code hahaha)

Are you still maintaining that repo ?

Thanks again.

cyperghost

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

It is the script I am using to navigate through the extracted pak files. Does this script is outdated? Do you have a newer version of that?

No - up to date version

My solution: I just inserted a "killall joy2key.py" at the very beginning and another one at the end of that script and everything is running perfect now. (sorry about the lack of elegance in my code hahaha)

Nice one ;)

Are you still maintaining that repo ?

No not this one... the OpenBOR version you are using is really outdated.
We can meanwhile use OpenBOR 6xxx - and then you do not need to unpack the paks ;)

fredcobain

@cyperghost does the OpenBOR 6xxx maintains the compatibility with the older version and games?

Can I have both running on retropie ?

cyperghost

@fredcobain No ... The original from the RetroPie setup NEEDS extracted PAK files. All other versions use the non extracted parts.

I've the old counterpart in my repro that is nearly same version as the one RetroPie offers. And you can install side my side. But then you need the extracted files.

The more modern 6510 version offers much more games like, HE-Man, The Avengers, Streets of Rage X2....

fredcobain

@cyperghost I meant about wether the OpenBOR6xxx is capable to run old OpenBOR games (compatible with 3400) in PAK format. What's your experience about that?

Does the "OpenBOR - Beats of Rage Engine Selection.sh" and the "OpenBOR - Ultimate GamePad Setup.sh" works for 6xxxx?

Thanks again!

cyperghost

@fredcobain For old engine vs. new engine capablities you're on your own. I think 90% of the old games run on new engines.

The Selection menu works. Because it's automatically installed if you choose the script installer. The GamePad setup will not run .... it's was only inteded for the old games. I dismissed the script because if you use an old engine vs. a new engine the "general" setup does not work anymore. Means you can't setup a masterfile for lets say v6510 and use it vor v3600 and vice versa.

If you have installed the new version I can help you to to accomplish a "kind" of auto settings nevertheless.