Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 3.71 KB

INSTALL.md

File metadata and controls

64 lines (40 loc) · 3.71 KB
Raw

gzDoom for iOS/iPadOS

I’ve been recently going through the process of getting gzDoom to run on iPadOS. I got it working and it uses the vulkan renderer with moltenvk layer to translate vulkan calls to Apple’s native metal api (like the macOS version).

Some warnings

Warning: This is WIP where stuff is missing (no touch support) or might break, but it works on iPadOs with an external mouse and keyboard (tested with Smart-Keyboard, Magic Keyboard and bluetooth mouse) and gamepad (tested with XBox Controller).

Warning: iOS. Technically it works but i just ran it a few times. As no touch input is supported you need a bluetooth keyboard/mouse to navigate the menu. I ran into one crash when i did some quick tests....

Warning: Due to the way iPadOS/iOS work it’s not possible to distribute an app via the internet thus it needs to be compiled and deployed locally to an device connected to a Mac with Xcode.

Required

  • iPad, iPhone running at least iOS/iPadOS 14.5
  • a Mac with Xcode (12 at least) and brew installed
  • an Apple developer account

Building

  • install sdl2 via brew: brew install sdl2

  • checkout repo from terminal with: git clone https://github.com/baumhoto/gzdoom.git

  • open xcode project in gzdoom/gzdoom-ios/gzdoom.xcodeproj

  • adjust team and bundle identifier under gzDoom xcode

  • deploy to device

  • start app first time it will show an error message about missing gamedata. After the dialog is closed the app will quit, but there should be a gzdoom folder in the Files App under "On my iPad". gzDoom folder

  • Copy all the files/folders from the gzdoom/gzdoom/support folder here and add an IWAD file of your choice e.g doom.wad or heretic.wad etc. afterwards folder contents should look like this gzDoom folder contents

  • Start app again. Start game and use WSAD/mouse to run game or configure gamepad.

Full options menu is available but some changes might not work or break it

adding addional datafiles

in the gzdoom-folder in "On my iPad" is a config folder which contains the gzdoom configuration file gzdoom.ini. This is the usual zdoom config file. The path needs to be specified a little bit different as the gzDoom-Folder in ''On my iPad is the Documents folder of the app. So to add an additional wad or pk3 file use a path like this e.g. the lights.pk3 file

Path=$HOME/Documents/lights.pk3

if you had an subfolder wads in the gzDoom folder it would be *Path=$HOME/Documents/wads/mywad.wad

Here is an example configuration with some mods: gzDoom config

For now you need it will pick the first IWAD it finds thus only one in the main gzDoom-Dir

HighDpi/Retina

By default it runs in Non-Retina resolution. You can set the cmd vid_hidpi to 1 and quit the app so the value get saved in the config. On restarting the app it should use the full retina resolution.

iPad Pro Motion Display

The main doomloop is now run by UIKit CADisplaylink, so it tells the OS the preferred framerate which by default is the maximum framerate supported by the devices display. So the maximum refreshrate of the devices display limits the max fps you will get. For the iPad Pro's with their 120hz display you can limit the framerate to 60 by setting vid_maxfps to 60.

Performance

Doom 1 Ultimate E1M1 no mods:

1366x1024:

  • iPad Pro 12.9 2nd Gen (A10X) ~ 80 fps
  • iPad Pro 12.9 5th Gen (M1) ~ 120 fps (limited by display)