izanagi-2022/README.md

izanagi

A run-and-gun shooter inspired by Metal Slug.

Setup

Note: CMake and OpenSSL are required.

Windows

The following tools are required:

• Windows SDK

These required tools may be installed via Chocolatey (recommended):

• CMake

• Ninja

• Clang

  Set your CC environment variable to the full path of clang-cl.exe

  Set your CMAKE_MT environment variable to the full path of mt.exe, which can be found on your Windows SDK installation folder (usually C:/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/mt.exe)

Note: The CMake cache might be filled in with library paths that might be unknown when Visual Studio is installed. It will cause errors in building. Run the scripts provided in this project to ensure that the correct library paths are supplied.

1. Clone this repo.
2. Clone the repositories under dependencies.txt except for SDL2.
3. Unpack the MSVC archive under dependencies folder in this project’s root. Rename the directory as SDL2.
4. Build the following dependencies first:
   • portmidi
   • libwebsockets (follow the instructions on building LWS)
5. Build via CMake.

macOS/*NIX

1. Clone this repo.

2. Clone the repositories under dependencies.txt, including SDL2.

3. Build the SDL, SDL_image, and SDL_ttf dependencies using the build instructions for Linux/UNIX or build instructions for macOS.

   Note: You may need to download other tools to build the libraries:

   • autoconf
   • make

   Note: Clone the submodules under SDL_ttf to download freetype and harfbuzz:

   git submodule update --init --recursive
   

4. For OpenSSL, simply run:

   ./Configure
   make
   make test
   

5. Build the following dependencies first:

   • portmidi (Linux needs ALSA libraries to be compiled)
     • ALSA Lib requires libtool to be compiled.
   • libwebsockets (follow the instructions on building LWS)

6. Build via CMake.