Initial release for Nintendo Switch

README.md

@@ -1,64 +1,73 @@
-fheroes2
-======
-[![Github Downloads (monthly)](https://img.shields.io/github/downloads/ihhub/fheroes2/total.svg)](https://github.com/ihhub/fheroes2/releases) [![Discord](https://img.shields.io/discord/733093692860137523.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xF85vbZ) [![Facebook](https://img.shields.io/badge/Facebook-blue.svg)](https://www.facebook.com/groups/fheroes2) [![VK](https://img.shields.io/badge/VK-blue.svg)](https://vk.com/fheroes2) [![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg)](https://www.patreon.com/fheroes2)
+This is a port of Free Heroes 2 (free implementation of Heroes of Might and Magic 2 engine) to Nintendo Switch.
+It's a homebrew app, so you need to be running custom firmware for it to work.
 
-Free implementation of Heroes of Might and Magic II engine.
 
-<img src="files/images/screenshots/screenshot_world_map.png?raw=true" width="410"> <img src="files/images/screenshots/screenshot_castle.png?raw=true" width="410">
+[1] BUILDING
+------------
 
-Download
----------------------------
-You can download a compiled version of the game for your operating system via [**Github releases**](https://github.com/ihhub/fheroes2/releases) of this project.
+If you're targeting Nintendo Switch, make sure you're using the `switch` branch. The `master` branch contains changes which are not specific to Switch and could be used on other platforms.
 
-Please note that for **32-bit** version of the game on **Windows OS** you have to install [**Visual Studio 2015 Redistributable (vc_redist.x86.exe)**](https://www.microsoft.com/en-sg/download/details.aspx?id=48145) if you face an error during application startup.
+You will need to install the [devkitPro](https://devkitpro.org/) toolchain. Make sure to include the following packages:
 
-Copyright
----------------------------
-All rights for the original game and its resources belong to former The 3DO Company. These rights were transferred to Ubisoft. We do not encourage and do not support any form of illegal usage of the original game. We strongly advise to purchase the original game on [**GOG**](https://www.gog.com) or [**Ubisoft Store**](https://store.ubi.com) platforms. Alternatively, you can download a free demo version of the game.
+    libnx switch-sdl2_image switch-sdl2_mixer switch-sdl2_ttf
 
-Requirements
----------------------------
-You are required to have at least a demo version of Heroes of Might and Magic II game to be able to play it. Please use one of our scripts to download the demo version of the original game. A script comes with the compiled game.
+Then follow the usual steps to build Free Heroes 2.
 
-MacOS and Linux
---------------------------
-Unix OSes need an explicit installation of SDL. Please go to `script/macos` or `script/linux` directory depending on your OS package and run **install_sdl_1.sh** or **install_sdl_2.sh** file. For Arch based Linux distributions use the command `sudo pacman -S sdl sdl_mixer` instead. RPM based distributions like Fedora/Red Hat use the commands `sudo yum/dnf install SDL*`. openSUSE supports the One-Click-Install via `SDL_mixer.ymp` file in `script/linux`. For MacOS we highly recommend to use SDL 2 as latest versions of MacOS do not fully support SDL 1.
+If you don't intend to do any coding and just want to play, grab the latest [release](https://github.com/dimag0g/fheroes2/releases) instead.
 
 
-Compilation
----------------------------
-[![Build status](https://travis-ci.org/ihhub/fheroes2.svg?branch=master)](https://travis-ci.org/ihhub/fheroes2) [![Build status](https://ci.appveyor.com/api/projects/status/ih6cw0yr1yuxf4ll?svg=true)](https://ci.appveyor.com/project/ihhub/fheroes2) [![Build Status](https://github.com/ihhub/fheroes2/workflows/GitHub%20Actions/badge.svg)](https://github.com/ihhub/fheroes2/actions)
+[2] SETUP
+---------
 
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ihhub_fheroes2&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ihhub_fheroes2) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ihhub_fheroes2&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=ihhub_fheroes2) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=ihhub_fheroes2&metric=bugs)](https://sonarcloud.io/dashboard?id=ihhub_fheroes2) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=ihhub_fheroes2&metric=code_smells)](https://sonarcloud.io/dashboard?id=ihhub_fheroes2) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=ihhub_fheroes2&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=ihhub_fheroes2) [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/ihhub/fheroes2.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ihhub/fheroes2/context:cpp) [![Total alerts](https://img.shields.io/lgtm/alerts/g/ihhub/fheroes2.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ihhub/fheroes2/alerts/)
+You will need a copy of the official game to run this port.
 
-Please follow below instructions to be able to compile the project:
+Free Heroes 2 root directory is hardcoded as `/switch/fheroes2`. Put the game files there (specifically `ANIM`, `DATA`, `MAPS` and `MUSIC` folders),
+then copy over the `files` directory, as well as `fheroes2.nro`. `ANIM` and `MUSIC` folders are optional: you can play without any music or movies.
+If you don't have the `ANIM` folder, create it and copy whatever `*.smk` files you have from `DATA` to `ANIM`.
 
-Windows
-------------------------
-- **Optional step**: Install **7-zip** archiver at its default location as `C:\Program Files\7-Zip\7z.exe` or otherwise, you will need to manually extract each downloaded package (follow instructions shown by batch scripts mentioned below).
-- open `script/windows` directory and run **install_packages.bat** file. It installs necessary packages for Visual Studio build.
-- open `script/demo` directory and run **demo_windows.bat** file. It downloads a demo version of the game which is needed for minimum development.
-- open **fheroes.vcxproj** by Visual Studio and compile the project.
 
-MacOS and Linux
--------------------
-- open `script/macos` or `script/linux` directory depending on your OS and run **install_sdl_1.sh** or **install_sdl_2.sh** file. For MacOS we recommend to run SDL 2 as latest versions of MacOS does not support SDL 1 fully.
-- open `script/demo` directory and run **demo_macos.sh** or **demo_linux.sh** file depending on your OS. It downloads a demo version of the game which is needed for minimum development.
-- run `make` command in root directory of the project. For SDL 2 compilation please run `export WITH_SDL2="ON"` command before compiling the project.
+In the end you should have the following directory tree on your SD card:
 
-Contribution
----------------------------
-We welcome and appreciate any help, even if it is a tiny text or code change. Please read [contribution](https://github.com/ihhub/fheroes2/blob/master/CONTRIBUTING.md) page before starting work on a pull request. All contributors are listed in the project's wiki [page](https://github.com/ihhub/fheroes2/wiki/Contributors). 
-Not sure what to start with? Feel free to refer to [good first issue](https://github.com/ihhub/fheroes2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [help wanted](https://github.com/ihhub/fheroes2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tags.
+    switch
+     |
+     +-- ...
+     +-- fheroes2  <--- this is the game directory
+         |
+         +--- anim
+		 +--- data
+         +--- files
+         +--- maps
+         +--- music
+         +--- fheroes2.nro
 
-License
----------------------------
-This project is under GNU General Public License v2.0. Please refer to file [**LICENSE**](https://github.com/ihhub/fheroes2/blob/master/LICENSE) for more details.
 
-The original project had been developed at [sourceforge](https://sourceforge.net/projects/fheroes2/)
+[3] RUNNING
+-----------
+
+This build of Free Heroes 2 was tested on 10.2.0|AMS 0.14.4|S (FAT32). exFAT is not recommended.
+Alternative controllers (keyboards, mouses, etc.) might work but weren't tested.
+
+Working controls controls are:
+- Touchscreen - emulates mouse, including dragging
+- L-stick - move mouse cursor
+- A - left mouse click
+- B - Right mouse click
+
+
+[4] TODO
+--------
+
+Here's a list of known bugs / missing features, approximately in order of priority. Don't bother reporting those as issues.
+
+- cursor is invisible
+- locales are not supported
+
+
+The game icon was downloaded from [this page](https://iconarchive.com/show/mega-games-pack-28-icons-by-3xhumed/Heroes-II-of-Might-and-Magic-2-icon.html)
+with the following copyright notice:
+
+>Artist: Exhumed
+>License: CC Attribution-Noncommercial-No Derivate 4.0
+>Commercial usage: Not allowed
 
-Donation
----------------------------
-Currently we accept donations via Patreon and PayPal. All donations will be used only for the future project development as we do not consider this project as a source of income by any means.
 
-[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg)](https://www.patreon.com/fheroes2) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/paypalme/fheroes2)

src/Makefile.switch

@@ -0,0 +1,13 @@
+PREFIX	= $(DEVKITPRO)/devkitA64/bin/aarch64-none-elf-
+
+CC = $(PREFIX)gcc
+CXX = $(PREFIX)g++
+AR = $(PREFIX)ar
+
+ARCH = -march=armv8-a+crc+crypto -mtune=cortex-a57 -mtp=soft -fPIE
+CFLAGS := $(CFLAGS) $(ARCH) -D__SWITCH__ -DWITHOUT_MOUSE
+CXXFLAGS := $(CXXFLAGS) $(ARCH) -D__SWITCH__ -DWITHOUT_MOUSE
+CFLAGS_TP := $(CFLAGS_TP) $(ARCH)
+CXXFLAGS_TP := $(CXXFLAGS_TP) $(ARCH)
+
+LIBS := $(LIBS) -lSDL2 -lfreetype -lbz2 -lvorbisidec -lmodplug -lmpg123 -lm -lopusfile -logg -lopus -ljpeg -lwebp -specs=$(DEVKITPRO)/libnx/switch.specs

src/engine/engine.cpp

@@ -47,6 +47,12 @@ bool SDL::Init( const u32 system )
         ERROR( SDL_GetError() );
         return false;
     }
+
+#ifdef __SWITCH__
+    SDL_InitSubSystem(SDL_INIT_JOYSTICK);
+    SDL_JoystickEventState(SDL_ENABLE);
+    SDL_JoystickOpen(0);
+#endif
 
     if ( SDL_INIT_AUDIO & system )
         Mixer::Init();