ECWolf - Wolfenstein 3D source port for mods

tpo1990

Big news. The ECWolf scriptmodule has been updated with a major revision to the code making it easier to locate the game data files of both shareware and registered versions of Wolfenstein 3D and Spear of Destiny episodes.

A keyboard escape fix patch has been added to make it much more easier to map your controller to the escape key for exiting the game. Mods can now be added in a much more structured way thanks to @cyperghost work. (You can find the mod instructions on the first post in the topic).

Run the Download again and update your ECWolf installation or uninstall first, then download and reinstall again.

The scriptmodule is not for testing anymore and is now recognized as a stable release. It might just see a PR soon for the RetroPie project. :-)

cyperghost

@tpo1990 It would be nice if you would include the patch also in your repro ;)
Why? If I delete my branch then the file is lost.

Please don't copy and paste the text, rather download the file and upload it again.
Why? With copy and paste you will likely lose line endings and then the patch will not work.

Therefore are PR are state of the art in software development ;) They are a history lookback in the code source.

Look at your code idents, in the codeblock

function sources_ecwolf() {
    downloadAndExtract "https://bitbucket.org/ecwolf/ecwolf/get/5065aaefe055.zip"
    mv ecwolf-ecwolf-5065aaefe055 ecwolf
}

you've setted 8 spaces instead of 4 ;)

Keep up the good work. Thank you for this jewel
Best wishes

cyperghost

@tpo1990
Thanks for merging ;) ... one little last thing....

wget -N -q https://raw.githubusercontent.com/tpo1990/ECWolf-RPI/master/ecwolf_keyboardpatch.diff

I removed the --show-progress switch (just for cosmetics) and more important... the download points to your repro. So you've 100% control of your future PRs

About the patch, I'm not sure if there is a better way to use the patch inside the scriptmodules but I recieved no answer as I asked for this :(

Next stop: Retrogaming of Wolfenstein 2D ;)

tpo1990

@cyperghost No problem. It has now been corrected in latest git.

Thanks to you the scriptmodule is much more refined. I noticed it also. Maybe we will receive a answer for a better way of applying the patch, otherwise it will still work fine as it is. Perhaps, when after creating the PR for RetroPie project someone could come up with a better way.

Now that is a title i have never tried out. I might as well try it out some time. :-)

Happy retrogaming ;-)

cyperghost

@tpo1990 I think we can use applyPatch
Instead of the patch -i -p0 command just use applyPatch
I think this could work...

apply Patch uses -f -p1 command

Difference between p1 und p0 is
- p0: ./src/wl_play.cpp
- p1: src/wl_play.cpp

So this may work out of the box! Maybe @mitu can say more to this - patchfile is here -- thank you.
The -i switch isn't needed here because helpers.sh redirects file output to patch command with patch -f -p1 <"$patch"

The reason for using the helpers functions is, that they give feedback to the processing with error codes. You can try out if this works and then I'm really out of my knowledge. I think that patches then are stored to RetroPie-Setup.

tpo1990

@cyperghost According to helpers.sh file, the function applyPatch is used for applying patches against upstream code and will apply a patch if it has not already been applied to the current folder.

This sounds like it could actually work, so meaning.

applyPatch -f -p1 ecwolf_keyboardpatch.diff

Let me try it out and get back to you.

cyperghost

@tpo1990 No... use only

applyPatch ecwolf_keyboardpatch.diff

please

The applyPatch function accepts just one argument - the patchfile itself

See here

tpo1990

@cyperghost I see. I am trying again.

Until now at this point it did apply the patch with the applyPatch so far so good.

Edit: Just tested it in game. It works. I can see the escape game key function in options.

cyperghost

@tpo1990 There should be now a (empty) file named ecwolf_keyboardpatch.diff.applied be inside the build folder.
(So the helpers function says)
You know $HOME/RetroPie-Setup/tmp/build/ecwolf/ecwolf (??)

Edit: Just tested it in game. It works. I can see the escape game key function in options.

Perfect! But if you see the messsage of a patched file you can break the process. It will work as usual. But consider this is testing ;)

tpo1990

@cyperghost Yes i noticed when i first tried the applyPatch function, it failed at the end when trying to install ecwolf with a patch failed message.

There is no empty file to be found inside the build folder "$HOME/RetroPie-Setup/tmp/build/ecwolf/ecwolf"

The actual tmp/build folder is empty when i look into it.

cyperghost

@tpo1990 I think the folder automatically gets cleanded up.
But does the applyPatch inside the scriptmodule works?
Because in your first posting you said there was a successfull build.
As far as my understanding is that you usually compare two files
a/sourcedir/testfile.dat
b/sourcedir/testfile.dat

With -p1 you strip to sourcedir/testfile.dat

I used ./sourcedir/testfile.dat and testfile.dat
So with -p1 I also obtain sourcedir/testfile.dat
so I'm sure that the applyPatch function will work ;)

About the path.... Maybe I remebered it wrong (can't test)

Yes the patch command fails if the file ecwolf_keyboardpatch.diff.applied is present. Then an error is added to ouput therefore the file needs to be deleted or you clean up the whole source build with RetroPie-Setup and the option in the dialog menu Z clean build

tpo1990

@cyperghost It does seems to automatically clean up the tmp/builder folder after finalizing the install process of ECWolf scriptmodule.

I haven't noticed any other errors or points that need to be fixed yet. I can not see which file to compare with. Well you can always test it when you get back. For now i can reupload the file with the applyPatch addition.

Usually when the install process fails, it will present a clean source option in the RetroPie-Setup menu for that scriptmodule.

cyperghost

@tpo1990 So the applyPatch function works and you can build a ecWolf binary ;)
Perfect! Then modify the code with the applyPatch function and as you said, upload it
..... I may investigate the helpers.sh script later after my vacation.
Thank you ;)

Usually when the install process fails, it will present a clean source option in the RetroPie-Setup menu for that scriptmodule.

Yes and therefore your modifications works like they should

EDIT:
It's a pleasure to develop with you. Thank you

tpo1990

@cyperghost Okay so i have now uploaded latest change to my git repo for the applyPatch implementation in the ecwolf scriptmodule.

Great at this point i think i will leave the scriptmodule as it is at the moment and later create a PR for RetroPie project.

You too. Thank you as well. :-)

cyperghost

@tpo1990 I took a quick investigation inside the helpers.sh
There is no other function to get files.... So I really have nothing to add here.
Maybe some improvements for the ls command to find the empty dir (ls -A) should be used for portabilty reasons but I think that only a sidenote because we usually build on Raspbian systems.

So my final words. Nothing to add.
For me I learned some new things

{!array[@]} for searching the indexes of an array, usually you probe the value of the index
-print -quit for findcan be very usefull (You have to know that find needs some special treatments for recurse file operations)
Never use ls for listing files and handling them in your script, except you will check if the directory is empty or not
patch -p# this was just an usecase by accident, but did work so far .... I hope my explainations what is the difference between p1 and p0 did not confuse you and I hope the explaination is right ;)

cyperghost

@SinisterSpatula said in OpenBOR 6xxx OpenBeta Testphase:

@cyperghost I'm back to being just an average joe, not making images, not part of a team. I'll get right on this tomorrow :)

Yes but your attitude is correct and I like your tutorials for the GPi case.

Back to topic:
I think we should use this thread for posting ecWolf issues ;)

The ecWolf scriptmodule itself can be considered as RC1 it needs just one or two thing in code polishing (remove the dots for find and downloadAndExtract, add ls -A) but these are just minor things and it should do it's job as expected

SinisterSpatula

Retroflag Gpi/Pi zero Testing

Forward = JY11 (D-pad up)
Backward = JY12 (D-pad down)
Turn left = JY13 (D-pad left)
Turn right = JY14 (D-pad right)
Attack = JY0 (A Button)
Use = JY1 (B button)
Strafe = JY3 (Y button)
Run = JY2 (X button)
Next Weapon = JY10 (LB button)
Prev Weapon = JY9 (RB button)
Escape Game = JY4 (Select Button)
Start button is not being detected when I try to assign it. But it is in fact
working as an ESC button.

I hear a buzzing when I press the B button (JY1/Use) Same buzz if I press Spacebar which is assigned to Use.

The game is showing mouse curson on screen, need to disable that. (even with mouse disabled in controls)

Turning speed and movement speed are great without any change.
Very nice and playable, smooth, fast, good performance, music sounds great, no crackles or static. I did not need to use the --extravbls 2 to get good performance, however when I tried it, it does seem to be slightly better.

I could exit the game just fine.

This plays very nice!

Menu's navigate nicely. B button is working to back out of menu's. A button is working to select a menu item. Only weirdness is if you want to setup inputs the A button is "firing twice" or something, it get's ready to take the input you want to set but then immediately takes A as the new button also. (So there's no way currently other than bluetooth keyboard to setup controls due to this)

Config file here:
https://github.com/SinisterSpatula/Misc/blob/master/ecwolf.cfg

Youtube video here:

tpo1990

@cyperghost Good learning. I have not looked any further into the helpers file other than the applyPatch and downloadAndExtract funciton. I could probably learn a thing or two from it.

Now all that is left is just some further code polishing and then it will be ready for PR.

I agree that all folks here should only post ECWolf or Wolfenstein 3D related issues or posts so that we can maintain a clean topic.

tpo1990

@SinisterSpatula Thank you for this nice review and testing of ECWolf on the Retroflag GPI case. It seems to run very good. :-)

I think your modified ecwolf config file could provide useful to those that use the same case and that it is a good idea to add a link to the extra post that i have reserved at the moment, if i may do so with your accept.

cyperghost

@SinisterSpatula Thank your for this demo. ecWolf seems to run perfect on Pi1/0 then.

I think your button layout is okay. You properly missing the "MAP" options and I think the "SELECT" button is a good one for this.

I hear a buzzing when I press the B button (JY1/Use) Same buzz if I press Spacebar which is assigned to Use.

bzzzz bzzz ... That's the game engine, don't worry

The game is showing mouse curson on screen, need to disable that. (even with mouse disabled in controls)

Yes that's common. I disabled it, by setting mouse controls to off, activated fullscreen. Then the mouse is still showing but will vanish after next restart of ecWolf.

Turning speed and movement speed are great without any change.
Very nice and playable, smooth, fast, good performance, music sounds great, no crackles or static. I did not need to use the --extravbls 2 to get good performance, however when I tried it, it does seem to be slightly better.

Yes the --extravbls 2 sets the CPU usage massive down. On my Raspberry3 the peak CPU usage was 80%, with the switch sette I'm down to 50%. So my biggest concern was that the Pi0/1 is to weak for this game.

I could exit the game just fine.

Yes with START and SELECT button I assume.
because your button layout is ....Start button is not being detected when I try to assign it. But it is in fact working as an ESC button. Therefore I assume that the SELECT button is free mabe for the Automap function ;)

Menu's navigate nicely. B button is working to back out of menu's. A button is working to select a menu item. Only weirdness is if you want to setup inputs the A button is "firing twice" or something, it get's ready to take the input you want to set but then immediately takes A as the new button also. (So there's no way currently other than bluetooth keyboard to setup controls due to this)

Yes that's one of the caveeats now, you neeed a keyboard to navigate and reassign the keyboard layout inside the graphics menu or by using SSH edit. Therefore your premade config is worth to use it for the GPi case. Because not everybody is owner of a Bluetooth keyboard ;)

So thank you again for this nice review. If you need help how to add the fullversions then read description in posting 1. So I caused the usage of these .ecwolf files with the background of giving wolf3d the possibilty as own "system" inside ES.

The .ecwolf files are simple bash scripts. You need to enter the directory with the game data and then you can parse commands to the binary.
/opt/retropie/ports/ecwolf/ecwolf --data wl6 (case sensitive!) will load the full version
/opt/retropie/ports/ecwolf/ecwolf --data wl6 --file ../addons/ECWolf_hdpack.pk3 ../addons/ECWolf_hdmus_3DO.pk3 loads full version in HD mode ;)

More info about my file layout is here