diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml index a376c55ea..f5a15e839 100644 --- a/.github/workflows/c-cpp.yml +++ b/.github/workflows/c-cpp.yml @@ -78,10 +78,46 @@ jobs: path: bin/ retention-days: 0 + build-flatpak-bundle: + name: "Build flatpak bundle" + runs-on: ubuntu-latest + needs: [build-i686-linux] + container: + image: bilelmoussaoui/flatpak-github-actions:freedesktop-23.08 + options: --privileged + steps: + - uses: actions/checkout@v4 + - uses: actions/download-artifact@v4 + with: + name: pd-i686-linux + path: dist/linux/bin/ + + - uses: flatpak/flatpak-github-actions/flatpak-builder@v6 + with: + bundle: io.github.fgsfdsfgs.perfect_dark.flatpak + manifest-path: dist/linux/io.github.fgsfdsfgs.perfect_dark.yaml + cache-key: flatpak-builder-${{ github.sha }} + upload-artifact: true + + # - name: Build Flatpak bundle + # run: | + # cd dist/linux/ + # flatpak-builder build --force-clean io.github.fgsfdsfgs.perfect_dark.yaml + # flatpak build-export export build + # flatpak build-bundle export io.github.fgsfdsfgs.perfect_dark.flatpak io.github.fgsfdsfgs.perfect_dark + + - name: Upload artifact + uses: actions/upload-artifact@v4 + with: + name: io.github.fgsfdsfgs.perfect_dark.flatpak + path: io.github.fgsfdsfgs.perfect_dark.flatpak + retention-days: 0 + + publish-latest-build: runs-on: ubuntu-latest if: github.ref == 'refs/heads/port' - needs: [build-i686-windows, build-i686-linux] + needs: [build-i686-windows, build-i686-linux, build-flatpak-bundle] permissions: contents: write steps: @@ -97,6 +133,7 @@ jobs: pushd ci-artifacts tar czf ../ci-release/pd-i686-linux.tar.gz pd-i686-linux zip -r ../ci-release/pd-i686-windows.zip pd-i686-windows + mv io.github.fgsfdsfgs.perfect_dark.flatpak/io.github.fgsfdsfgs.perfect_dark.flatpak ../ci-release/ popd git tag --force ci-dev-build port git push --force origin ci-dev-build diff --git a/.gitignore b/.gitignore index 4aaf2032f..036ef12cf 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ *.exe pd.*.z64 build +.flatpak-builder extracted src/assets/*/*.bin src/assets/*/*.ctl diff --git a/README.md b/README.md index 7fd5bbe0d..54c203e43 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ There are minor graphics- and gameplay-related issues, and possibly occasional c * experimental high framerate support (up to 240 FPS): * set `Game.TickRateDivisor` to `0` in `pd.ini` to activate; * in practice the game will have issues running faster than ~165 FPS, so use VSync or `Video.FramerateLimit` to cap it. +* emulate the Transfer Pak functionality the game has on the Nintendo 64 to unlock some cheats automatically. Currently only 32-bit platforms are supported, namely x86 Windows and Linux. Note that 32-bit binaries will still work on 64-bit versions of those platforms, @@ -68,6 +69,8 @@ If you want to use a PAL or JPN ROM instead, put them into the `data` directory * PAL: ROM name `pd.pal-final.z64`, EXE name `pd.pal.exe`. * JPN: ROM name `pd.jpn-final.z64`, EXE name `pd.jpn.exe`. +Optionally, you can also put your Perfect Dark for GameBoy Color ROM named `pd.gbc` in the `data` directory if you want to emulate having the Nintendo 64's Transfer Pak and unlock some cheats automatically. + Note that users with different ROMs can't play netgames with each other. Additional information can be found in the [wiki](https://github.com/fgsfdsfgs/perfect_dark/wiki). diff --git a/dist/linux/io.github.fgsfdsfgs.perfect_dark.desktop b/dist/linux/io.github.fgsfdsfgs.perfect_dark.desktop new file mode 100755 index 000000000..663933b7e --- /dev/null +++ b/dist/linux/io.github.fgsfdsfgs.perfect_dark.desktop @@ -0,0 +1,9 @@ +[Desktop Entry] +Name=Perfect Dark +Comment=Modern source port of Perfect Dark +Exec=pd +Icon=io.github.fgsfdsfgs.perfect_dark +Terminal=false +Type=Application +Categories=Game;ActionGame; +StartupNotify=false diff --git a/dist/linux/io.github.fgsfdsfgs.perfect_dark.metainfo.xml b/dist/linux/io.github.fgsfdsfgs.perfect_dark.metainfo.xml new file mode 100644 index 000000000..10a2f92ee --- /dev/null +++ b/dist/linux/io.github.fgsfdsfgs.perfect_dark.metainfo.xml @@ -0,0 +1,45 @@ + + + io.github.fgsfdsfgs.perfect_dark + Perfect Dark + + Perfect Dark Contributors + https://github.com/fgsfdsfgs/perfect_dark/graphs/contributors + + io.github.fgsfdsfgs.perfect_dark.desktop + Modern cross-platform port of Perfect Dark + CC0-1.0 + MIT + https://github.com/fgsfdsfgs/perfect_dark/ + +

This is a port of Ryan Dywer's decompilation of classic N64 shooter Perfect Dark to modern systems.

+ + + + Game + ActionGame + Shooter + + + n64 + scifi + cyberpunk + retro + sourceport + port + + + + + + moderate + mild + + https://github.com/fgsfdsfgs/perfect_dark/ + diff --git a/dist/linux/io.github.fgsfdsfgs.perfect_dark.png b/dist/linux/io.github.fgsfdsfgs.perfect_dark.png new file mode 100644 index 000000000..24f45c18d Binary files /dev/null and b/dist/linux/io.github.fgsfdsfgs.perfect_dark.png differ diff --git a/dist/linux/io.github.fgsfdsfgs.perfect_dark.sh b/dist/linux/io.github.fgsfdsfgs.perfect_dark.sh new file mode 100644 index 000000000..0e163c2a9 --- /dev/null +++ b/dist/linux/io.github.fgsfdsfgs.perfect_dark.sh @@ -0,0 +1,38 @@ +#!/bin/sh + +# Create user data directories if necessary +userdirs=( roms saves mods ) +for path in "${userdirs[@]}"; do + if [ ! -d "${XDG_DATA_HOME}/${path}" ]; then + mkdir -p "${XDG_DATA_HOME}/${path}" + fi +done + +# Default to pd as executable but switch to jpn/pal if the NTSC rom +# is missing but JPN/PAL are present. +executable="pd" +if [ -f ${XDG_DATA_HOME}/roms/pd.ntsc-final.z64 ] | \ + [ -f ${XDG_DATA_HOME}/roms/pd.ntsc-1.0.z64 ]; then + executable="pd" +elif [ -f ${XDG_DATA_HOME}/roms/pd.jpn-final.z64 ]; then + executable="pd.jpn" +elif [ -f ${XDG_DATA_HOME}/roms/pd.pal-final.z64 ]; then + executable="pd.pal" +fi + +# If first parameter passed to this script is one of the pd executables, +# run that regardless of ROM auto-detection above and pass the remaining +# parameters to it; otherwise pass all arguments to the executable selected +# above +case $1 in + "pd."*) + executable=$1 + params="${@:2}" + ;; + *) + params="$@" + ;; +esac + +# Run game +$executable --basedir ${XDG_DATA_HOME}/roms --savedir ${XDG_DATA_HOME}/saves $params diff --git a/dist/linux/io.github.fgsfdsfgs.perfect_dark.yaml b/dist/linux/io.github.fgsfdsfgs.perfect_dark.yaml new file mode 100644 index 000000000..7ef407946 --- /dev/null +++ b/dist/linux/io.github.fgsfdsfgs.perfect_dark.yaml @@ -0,0 +1,93 @@ +app-id: io.github.fgsfdsfgs.perfect_dark +runtime: org.freedesktop.Platform +runtime-version: &runtime-version '23.08' +sdk: org.freedesktop.Sdk +command: io.github.fgsfdsfgs.perfect_dark.sh + +finish-args: + # multiarch is required for 32bit binaries + - --allow=multiarch + # hardware 3D and controller access + - --device=all + # X11 + XShm access + - --share=ipc + - --socket=x11 + # Audio + - --socket=pulseaudio + # Enable network for multiplayer + - --share=network + +# Parameters for 32-bit extensions +x-gl-version: &gl-version '1.4' +x-gl-versions: &gl-versions 23.08;1.4 +x-gl-merge-dirs: &gl-merge-dirs vulkan/icd.d;glvnd/egl_vendor.d;egl/egl_external_platform.d;OpenCL/vendors;lib/dri;lib/d3d;lib/gbm;vulkan/explicit_layer.d;vulkan/implicit_layer.d + +add-extensions: + org.freedesktop.Platform.Compat.i386: + directory: lib/i386-linux-gnu + version: '23.08' + + org.freedesktop.Platform.GL32: + directory: lib/i386-linux-gnu/GL + version: *gl-version + versions: *gl-versions + subdirectories: true + no-autodownload: true + autodelete: false + add-ld-path: lib + merge-dirs: *gl-merge-dirs + download-if: active-gl-driver + enable-if: active-gl-driver + autoprune-unless: active-gl-driver + + org.freedesktop.Platform.GL32.Debug: + directory: lib/debug/lib/i386-linux-gnu/GL + version: *gl-version + versions: *gl-versions + subdirectories: true + no-autodownload: true + merge-dirs: *gl-merge-dirs + enable-if: active-gl-driver + autoprune-unless: active-gl-driver + + org.freedesktop.Platform.VAAPI.Intel.i386: + directory: lib/i386-linux-gnu/dri/intel-vaapi-driver + version: *runtime-version + versions: *runtime-version + autodelete: false + no-autodownload: true + add-ld-path: lib + download-if: have-intel-gpu + autoprune-unless: have-intel-gpu + +modules: + - name: perfect_dark + buildsystem: simple + sources: + - type: file + path: bin/pd + - type: file + path: bin/pd.jpn + - type: file + path: bin/pd.pal + - type: file + path: io.github.fgsfdsfgs.perfect_dark.sh + - type: file + path: io.github.fgsfdsfgs.perfect_dark.png + - type: file + path: io.github.fgsfdsfgs.perfect_dark.metainfo.xml + - type: file + path: io.github.fgsfdsfgs.perfect_dark.desktop + build-commands: [] + post-install: + # create extension mountpoints + - mkdir -p /app/lib/i386-linux-gnu + - mkdir -p /app/lib/i386-linux-gnu/GL + - mkdir -p /app/lib/debug/lib/i386-linux-gnu/GL + - mkdir -p /app/lib/i386-linux-gnu/dri/intel-vaapi-driver + # port + - install -Dm 755 -t /app/bin/ pd* + - install -Dm 755 ${FLATPAK_ID}.sh /app/bin/${FLATPAK_ID}.sh + - install -Dm 644 ${FLATPAK_ID}.desktop /app/share/applications/${FLATPAK_ID}.desktop + - install -Dm 644 ${FLATPAK_ID}.metainfo.xml /app/share/metainfo/${FLATPAK_ID}.metainfo.xml + - install -Dm 644 ${FLATPAK_ID}.png /app/share/icons/hicolor/256x256/apps/${FLATPAK_ID}.png diff --git a/port/include/romdata.h b/port/include/romdata.h index 4f7fdabff..73e87e4eb 100644 --- a/port/include/romdata.h +++ b/port/include/romdata.h @@ -23,4 +23,6 @@ u8 *romdataSegGetData(const char *segName); u8 *romdataSegGetDataEnd(const char *segName); u32 romdataSegGetSize(const char *segName); +void gbcRomCheck(void); + #endif diff --git a/port/src/main.c b/port/src/main.c index 843c352a9..87e2d4deb 100644 --- a/port/src/main.c +++ b/port/src/main.c @@ -112,6 +112,7 @@ int main(int argc, const char **argv) audioInit(); romdataInit(); netInit(); + gbcRomCheck(); gameInit(); diff --git a/port/src/romdata.c b/port/src/romdata.c index d31db357f..ee1af61d4 100644 --- a/port/src/romdata.c +++ b/port/src/romdata.c @@ -11,6 +11,9 @@ #include "system.h" #include "preprocess.h" #include "platform.h" +#ifndef PLATFORM_N64 +#include "bss.h" +#endif /** * asset files and ROM segments can be replaced by optional external files, @@ -51,6 +54,9 @@ #define ROMDATA_MAX_FILES 2048 +#define GBC_ROM_NAME "pd.gbc" +#define GBC_ROM_SIZE 4194304 + u8 *g_RomFile; u32 g_RomFileSize; const char *g_RomName = ROMDATA_ROM_NAME; @@ -386,6 +392,45 @@ s32 romdataInit(void) return 0; } +void gbcRomCheck(void) +{ + u32 gbcRomSize; + u8* gbcRomFile = fsFileLoad(GBC_ROM_NAME, &gbcRomSize); + + if (!gbcRomFile) { + return; + } + + if (gbcRomSize != GBC_ROM_SIZE) { + free(gbcRomFile); + return; + } + + // ROM title + + if (memcmp(gbcRomFile + 0x134, "PerfDark VPDE", 15) != 0) { + free(gbcRomFile); + return; + } + + // Licensee code + + if (memcmp(gbcRomFile + 0x144, "4Y", 2) != 0) { + free(gbcRomFile); + return; + } + + // Header and global checksums + + if (gbcRomFile[0x14D] != 0xA1 || gbcRomFile[0x14E] != 0xAD || gbcRomFile[0x14F] != 0x0F) { + free(gbcRomFile); + return; + } + + g_validGbcRomFound = true; + free(gbcRomFile); +} + s32 romdataFileGetSize(s32 fileNum) { if (fileNum < 1 || fileNum >= ROMDATA_MAX_FILES) { diff --git a/src/game/mplayer/mplayer.c b/src/game/mplayer/mplayer.c index 62d8c34a3..e70b1dcd8 100644 --- a/src/game/mplayer/mplayer.c +++ b/src/game/mplayer/mplayer.c @@ -3182,6 +3182,21 @@ void mpRemoveSimulant(s32 index) mpGenerateBotNames(); } +#ifndef PLATFORM_N64 +void mpCopySimulant(s32 index) +{ + s32 dest = mpGetSlotForNewBot(); + + g_MpSetup.chrslots |= 1 << (dest + 4); + g_BotConfigsArray[dest].base.name[0] = g_BotConfigsArray[index].base.name[0]; + g_BotConfigsArray[dest].base.mpheadnum = g_BotConfigsArray[index].base.mpheadnum; + g_BotConfigsArray[dest].base.mpbodynum = g_BotConfigsArray[index].base.mpbodynum; + g_BotConfigsArray[dest].type = g_BotConfigsArray[index].type; + g_BotConfigsArray[dest].difficulty = g_BotConfigsArray[index].difficulty; + mpGenerateBotNames(); +} +#endif + bool mpHasSimulants(void) { #if MAX_PLAYERS > 4 diff --git a/src/game/mplayer/setup.c b/src/game/mplayer/setup.c index 23964881a..815a43aca 100644 --- a/src/game/mplayer/setup.c +++ b/src/game/mplayer/setup.c @@ -2979,6 +2979,24 @@ MenuItemHandlerResult menuhandlerMpDeleteSimulant(s32 operation, struct menuitem return 0; } +#ifndef PLATFORM_N64 +MenuItemHandlerResult menuhandlerMpCopySimulant(s32 operation, struct menuitem *item, union handlerdata *data) +{ + switch (operation) { + case MENUOP_SET: + mpCopySimulant(g_Menus[g_MpPlayerNum].mpsetup.slotindex); + menuPopDialog(); + break; + case MENUOP_CHECKDISABLED: + if (mpHasUnusedBotSlots() == 0) { + return true; + } + } + + return 0; +} +#endif + char *mpMenuTitleEditSimulant(struct menudialogdef *dialogdef) { sprintf(g_StringPointer, "%s", &g_BotConfigsArray[g_Menus[g_MpPlayerNum].mpsetup.slotindex].base.name); @@ -3197,6 +3215,16 @@ struct menuitem g_MpEditSimulantMenuItems[] = { 0, NULL, }, +#ifndef PLATFORM_N64 + { + MENUITEMTYPE_SELECTABLE, + 0, + MENUITEMFLAG_LOCKABLEMINOR | MENUITEMFLAG_LITERAL_TEXT, + (uintptr_t)"Copy Simulant\n", + 0, + menuhandlerMpCopySimulant, + }, +#endif { MENUITEMTYPE_SELECTABLE, 0, diff --git a/src/game/pak.c b/src/game/pak.c index 640108177..0472873b3 100644 --- a/src/game/pak.c +++ b/src/game/pak.c @@ -329,6 +329,10 @@ u8 g_PaksPlugged = 0; bool var80075d14 = true; #endif +#ifndef PLATFORM_N64 +bool g_validGbcRomFound = false; +#endif + u32 pakGetBlockSize(s8 device) { return device == SAVEDEVICE_GAMEPAK ? 0x10 : 0x20; @@ -5982,6 +5986,7 @@ s32 pak0f11e750(s8 device) bool gbpakIsAnyPerfectDark(void) { +#ifdef PLATFORM_N64 s8 i; for (i = 0; i < MAX_LOCAL_PLAYERS; i++) { @@ -5991,6 +5996,9 @@ bool gbpakIsAnyPerfectDark(void) } return false; +#else + return g_validGbcRomFound; +#endif } /** diff --git a/src/include/bss.h b/src/include/bss.h index 0f3ba492a..c3b4e94ac 100644 --- a/src/include/bss.h +++ b/src/include/bss.h @@ -293,5 +293,8 @@ extern struct bossfile g_BossFile; extern struct chrdata *g_MpBotChrPtrs[MAX_BOTS]; extern s32 g_JpnMaxCacheItems; extern s32 var8009d370jf; +#ifndef PLATFORM_N64 +extern bool g_validGbcRomFound; +#endif #endif diff --git a/src/include/game/mplayer/mplayer.h b/src/include/game/mplayer/mplayer.h index bb4b17e56..b2ab42f95 100644 --- a/src/include/game/mplayer/mplayer.h +++ b/src/include/game/mplayer/mplayer.h @@ -90,6 +90,9 @@ void mpCreateBotFromProfile(s32 botnum, u8 difficulty); void mpSetBotDifficulty(s32 botnum, s32 difficulty); s32 mpGetSlotForNewBot(void); void mpRemoveSimulant(s32 index); +#ifndef PLATFORM_N64 +void mpCopySimulant(s32 index); +#endif bool mpHasSimulants(void); bool mpHasUnusedBotSlots(void); bool mpIsSimSlotEnabled(s32 slot); diff --git a/src/include/game/mplayer/setup.h b/src/include/game/mplayer/setup.h index ebb915747..b92f76c6e 100644 --- a/src/include/game/mplayer/setup.h +++ b/src/include/game/mplayer/setup.h @@ -144,6 +144,9 @@ MenuDialogHandlerResult menudialogMpSimulant(s32 operation, struct menudialogdef MenuItemHandlerResult menuhandlerMpSimulantHead(s32 operation, struct menuitem *item, union handlerdata *data); MenuItemHandlerResult menuhandlerMpSimulantBody(s32 operation, struct menuitem *item, union handlerdata *data); MenuItemHandlerResult menuhandlerMpDeleteSimulant(s32 operation, struct menuitem *item, union handlerdata *data); +#ifndef PLATFORM_N64 +MenuItemHandlerResult menuhandlerMpCopySimulant(s32 operation, struct menuitem *item, union handlerdata *data); +#endif MenuItemHandlerResult menuhandlerMpChangeSimulantType(s32 operation, struct menuitem *item, union handlerdata *data); MenuItemHandlerResult menuhandlerMpClearAllSimulants(s32 operation, struct menuitem *item, union handlerdata *data); MenuItemHandlerResult menuhandlerMpAddSimulant(s32 operation, struct menuitem *item, union handlerdata *data);