Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added JFDuke3D, Duke Nukem 3D source port for smaller Pis #3803

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added JFDuke3D, Duke Nukem 3D source port for smaller Pis #3803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8f49834
Added jfduke3d, lightweight Duke3D source port
protocultor Nov 13, 2023
0b107d4
EDuke32 script correction
protocultor Nov 13, 2023
a800bed
Added jfsw, Shadow Warrior source port by JonoF
protocultor Nov 14, 2023
07041be
jfsw.sh now depends directly on 3fduke3d.sh
protocultor Nov 19, 2023
b56f781
Only one place to obtain Duke3D shareware
protocultor Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions scriptmodules/ports/eduke32.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,14 @@ function install_eduke32() {

function game_data_eduke32() {
local dest="$romdir/ports/duke3d"
if [[ "$md_id" == "eduke32" ]]; then
if [[ ! -f "$dest/duke3d.grp" ]]; then
mkUserDir "$dest"
local temp="$(mktemp -d)"
download "$__archive_url/3dduke13.zip" "$temp"
unzip -L -o "$temp/3dduke13.zip" -d "$temp" dn3dsw13.shr
unzip -L -o "$temp/dn3dsw13.shr" -d "$dest" duke3d.grp duke.rts
rm -rf "$temp"
chown -R $user:$user "$dest"
fi
if [[ ! -n $(find $dest -maxdepth 1 -iname duke3d.grp) ]]; then
mkUserDir "$dest"
local temp="$(mktemp -d)"
download "$__archive_url/3dduke13.zip" "$temp"
unzip -L -o "$temp/3dduke13.zip" -d "$temp" dn3dsw13.shr
unzip -L -o "$temp/dn3dsw13.shr" -d "$dest" duke3d.grp duke.rts
rm -rf "$temp"
chown -R $user:$user "$dest"
fi
}

Expand All @@ -107,7 +105,7 @@ function configure_eduke32() {
rm -f "$romdir/ports/Duke3D Shareware.sh"

if [[ "$md_mode" == "install" ]]; then
game_data_eduke32
[[ "$md_id" == "eduke32" ]] && game_data_eduke32

touch "$config"
iniConfig " " '"' "$config"
Expand Down
105 changes: 105 additions & 0 deletions scriptmodules/ports/jfduke3d.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
#!/usr/bin/env bash

# This file is part of The RetroPie Project
#
# The RetroPie Project is the legal property of its developers, whose names are
# too numerous to list here. Please refer to the COPYRIGHT.md file distributed with this source.
#
# See the LICENSE.md file at the top-level directory of this distribution and
# at https://raw.githubusercontent.com/RetroPie/RetroPie-Setup/master/LICENSE.md
#

rp_module_id="jfduke3d"
rp_module_desc="lightweight Duke3D source port by JonoF"
rp_module_licence="GPL2 https://raw.githubusercontent.com/jonof/jfduke3d/master/GPL.TXT"
rp_module_repo="git https://github.com/jonof/jfduke3d.git master"
rp_module_section="exp"
rp_module_flags=""

function depends_jfduke3d() {
local depends=(
libsdl2-dev libvorbis-dev libfluidsynth-dev
)

isPlatform "x86" && depends+=(nasm)
isPlatform "gl" || isPlatform "mesa" && depends+=(libgl1-mesa-dev libglu1-mesa-dev)
isPlatform "x11" && depends+=(libgtk-3-dev)
getDepends "${depends[@]}"
}

function sources_jfduke3d() {
gitPullOrClone
}

function build_jfduke3d() {
local gamedir="duke3d"
local require="duke3d"
local params=(RELEASE=1)

if [[ ! -z "$1" ]] && [[ ! -z "$2" ]]; then
gamedir=$1
require=$2
fi

params+=(DATADIR=$romdir/ports/$gamedir)

! isPlatform "x86" && params+=(USE_ASM=0)
! isPlatform "x11" && params+=(WITHOUT_GTK=1)
! isPlatform "gl3" && params+=(USE_POLYMOST=0)

if isPlatform "gl" || isPlatform "mesa"; then
params+=(USE_OPENGL=USE_GL2)
elif isPlatform "gles"; then
params+=(USE_OPENGL=USE_GLES2)
else
params+=(USE_OPENGL=0)
fi

make clean veryclean
make "${params[@]}"

md_ret_require="$md_build/$require"
}

function install_jfduke3d() {
md_ret_files=(
'build'
'README.md'
'GPL.TXT'
)

if [[ ! -z "$1" ]]; then
md_ret_files+=("$1")
else
md_ret_files+=('duke3d')
fi
}

function config_file_jfduke3d() {
local config="$1"
if [[ -f "$config" ]] || isPlatform "x86"; then
return
fi

# no config file exists, creating one
# with alsa as the sound driver
cat >"$config" << _EOF_
[Sound Setup]
MusicParams = "audio.driver=alsa"
_EOF_
chown -R $user:$user "$config"
}

function configure_jfduke3d() {
mkRomDir "ports/duke3d"
moveConfigDir "$home/.jfduke3d" "$md_conf_root/jfduke3d"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes configs/ports/jfduke3d right? Should it be configs/ports/duke3d/jfduke3d instead? Puts the jfduke3d inside configs/duke3d (which already exists for eduke32 module), instead of alongside it.


# params are just for parity with eduke32, last one is not supported
addPort "$md_id" "duke3d" "Duke Nukem 3D" "$md_inst/duke3d" "-j$romdir/ports/duke3d -addon 0"

if [[ "$md_mode" != "install" ]]; then
return
fi
game_data_eduke32
config_file_jfduke3d "$md_conf_root/jfduke3d/duke3d.cfg"
}
64 changes: 64 additions & 0 deletions scriptmodules/ports/jfsw.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#!/usr/bin/env bash

# This file is part of The RetroPie Project
#
# The RetroPie Project is the legal property of its developers, whose names are
# too numerous to list here. Please refer to the COPYRIGHT.md file distributed with this source.
#
# See the LICENSE.md file at the top-level directory of this distribution and
# at https://raw.githubusercontent.com/RetroPie/RetroPie-Setup/master/LICENSE.md
#

rp_module_id="jfsw"
rp_module_desc="Shadow Warrior source port by JonoF"
rp_module_help="Place your registered version game files in $romdir/ports/shadowwarrior"
rp_module_licence="GPL2 https://raw.githubusercontent.com/jonof/jfsw/master/GPL.TXT"
rp_module_repo="git https://github.com/jonof/jfsw.git master"
rp_module_section="exp"
rp_module_flags=""

function depends_jfsw() {
depends_jfduke3d
}

function sources_jfsw() {
gitPullOrClone
}

function build_jfsw() {
build_jfduke3d "shadowwarrior" "sw"
}

function install_jfsw() {
install_jfduke3d 'sw'
}

function gamedata_jfsw() {
local dest="$romdir/ports/shadowwarrior"
if [[ ! -n $(find $dest -maxdepth 1 -iname sw.grp) ]]; then
mkUserDir "$dest"
local temp="$(mktemp -d)"
download "ftp://ftp.3drealms.com/share/3dsw12.zip" "$temp"
unzip -L -o "$temp/3dsw12.zip" -d "$temp" swsw12.shr
unzip -L -o "$temp/swsw12.shr" -d "$dest" sw.grp sw.rts
rm -rf "$temp"
fi
chown -R $user:$user "$dest"
}

function configure_jfsw() {
local gamedir="$romdir/ports/shadowwarrior"

mkRomDir "ports/shadowwarrior"
moveConfigDir "$home/.jfsw" "$md_conf_root/sw/jfsw"
Copy link
Contributor

@s1eve-mcdichae1 s1eve-mcdichae1 Dec 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, the opposite. Should this just use configs/ports/sw like the RP-Extra module (which this would effectively replace, and there is no other SW module to share space with), or why the extra layer deep?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I though the same, but configs/ports/duke3d points directly to the config to EDuke32, and your idea would force the config of JFDuke3D to go inside the config of EDuke32 as a subdirectory. Imagine how that would appear inside the config directories of RetroPie (/opt/retropie/configs/ports), and most importantly, how the "home" directory would appear:

ports
  |
  |- duke3d (1)
        |
        |- jfduke3d (2)

~
|
|- .config
|     |
|     |- eduke32 (1)
|          |
|          |- jfduke3d (2)
|
|- .jfduke3d (2)

(1) and (2) are to see where the links point.

The "extra layer" you mention was inspired on how is currently treated for Quake 1 and 2, where the first layer is the name of the game, and inside them is every individual port for that game (compare tyrquake.sh and darkplaces-quake.sh to understand). It's just better organized and future-proofed, compared with how Duke 3D does it, which just has "the name of the game" as the destination for the config of just one of the ports. It's just something that didn't age well, because of the need for organization when having more than one port for a game.

I don't find that joining all the configs on the different ports under the "first port made" is a good idea, especially if the user wants to back up a config for a certain port; this user might find every single config for every port of that game included. Or if the players want to "reset the config" by cleaning the directory, they will find that they deleted the configs for all of the ports of that game.

Of course, there may be a better solution, but I dealed with a legacy problem the best I could. I just don't find mixing directories is a good idea, but if the owners of the project want that, it'll be done.

Copy link
Contributor

@s1eve-mcdichae1 s1eve-mcdichae1 Dec 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what you're saying is that it should actually be ports/duke3d/eduke32, but that that ship has sailed...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, exactly, that's what EDuke32 should have used since the beginning. Although I understand no one would have predicted the use of different ports for the same game, it would have been nice if it was considered in some form. In the ideal world, it would have been great if this change could be done without the user having to do anything on their end.

Still, this had me thinking again. What if JFDuke3D, instead of using configs/ports/jfduke3d, used configs/ports/dukenukem3d/jfduke3d? Even if we have the same game twice, at least there would be a place where the configs of a potential 3rd port of Duke Nukem 3D could be located, without filling more places on the "root" of ports. If you have a better idea, I'm all ears.

Copy link
Member

@joolswills joolswills Dec 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. The config locations for some things are not ideal, due to later additions. It might be worth me re-organising the configs for eduke32. I will come back to you. Sorry for the delay.


addPort "$md_id" "sw" "Shadow Warrior" "$md_inst/sw %ROM%" ""
[[ -n $(find $gamedir -maxdepth 1 -iname dragon.zip) ]] && addPort "$md_id" "sw" "Shadow Warrior Twin Dragon" "$md_inst/sw %ROM%" "-gdragon.zip"
[[ -n $(find $gamedir -maxdepth 1 -iname wt.grp) ]] && addPort "$md_id" "sw" "Shadow Warrior Wanton Destruction" "$md_inst/sw %ROM%" "-gwt.grp"

if [[ "$md_mode" != "install" ]]; then
return
fi
gamedata_jfsw
config_file_jfduke3d "$md_conf_root/sw/jfsw/sw.cfg"
}