mirror of https://github.com/odamex/odamex synced 2026-08-19 02:23:09 -04:00

History

Mia McMahill 939ce6b29c Remove STACK_ARGS This was a remnant from old ZDoom when builds were done with __fastcall instead of __cdecl. If Odamex builds ever used that, it has been a very long time. Because of this it, it ends up just being unecessary noise, and it doesn't do anything except on 32-bit targets anyway.		2026-07-31 03:37:04 -05:00
..
assets	Fix building for Switch.	2021-03-16 04:37:14 +01:00
nx_io.cpp	Hoist some c stdlib headers into odamex.h	2021-09-14 22:55:09 -04:00
nx_io.h	Fixes bad inputs on the menu + added custom key for Switch	2020-11-08 03:45:48 +01:00
nx_system.h	Remove STACK_ARGS	2026-07-31 03:37:04 -05:00
README.md	Update switch & vwii Readme files.	2021-03-16 14:42:30 +01:00

README.md

Informations required for Odamex on Nintendo Switch.

IMPORTANT INFO

You NEED to start the Homebrew with full applet support (= Start the homebrew launcher through an existing application, and NOT the gallery)!

Installation

Create a folder named odamex to the /switch folder of your microSD Card, and navigate to that folder.
Put odamex.nro and odamex.wad to that folder.

Where to add your wads?

There are several ways to add your IWADs/PWADs (DOOM.WAD, DOOM2.WAD, FREEDOOM2.WAD, ...):

By putting them inside /switch/odamex or /switch/odamex/wads ;
By putting them in a folder named .odamex, located in the root of your sd card;

Known Bugs :

Loading times makes the game go faster, to keep with uncapped framerates. It could lead to desyncs online until it syncs back after a few seconds. The same behaviour can happen if you go to the home menu, or put the console into sleep mode.
When starting the game, the keyboard will suddently appear. This is because of the way we currently handle the SDL2 keyboard.
Custom wad folders aren't supported right now.
Partial invisibility is blending in red, not black.
Quitting the game may give an error message that could make you unable to start any application, unless restarting the console.

Building from scratch

This has been built using devkitpro on Windows (using msys2). Linux/MacOSX users may need to slightly modify the commands.

Latest compilation has been tested as of December 30th 2020.

Preparing the environment

Make sure you have the latest DevKitPro/msys2 packages:

pacman -Syu

Getting all the required libraries :

pacman -Sy cmake switch-sdl2 switch-sdl2_mixer switch-curl switch-libvorbis switch-opusfile switch-zlib switch-pkg-config switch-libvorbisidec switch-libogg switch-libopus switch-libpng devkitpro-pkgbuild-helpers

(optional) - We will build an older SDL2-Mixer version that will support Timidity:


git clone https://github.com/fgsfdsfgs/SDL_mixer && cd SDL_Mixer

source $DEVKITPRO/switchvars.sh

sed 's|\$(objects)/play.*mus\$(EXE)||' -i Makefile.in

  LIBS="-lm" ./configure --prefix="${PORTLIBS_PREFIX}" \
    --host=aarch64-none-elf --disable-shared --enable-static \
    --disable-music-cmd \
    --enable-music-ogg-tremor \
	--enable-music-mod-modplug \
	--enable-music-midi \
	--enable-music-midi-timidity
	
make 
make install

Then replace all of the libSDL2_mixer.a/.la libraries to $DEVKITPRO

Making the required folders & compiling :

go to your odamex folder.

mkdir odamex_switch && cd odamex_switch

source $DEVKITPRO/switchvars.sh

cmake -Wno-dev -DCMAKE_TOOLCHAIN_FILE="$DEVKITPRO/switch.cmake" ../odamex

make