2D Run-and-gun shooter inspired by One Man's Doomsday, Counter-Strike, and Metal Slug.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.9 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. # izanagi
  2. A run-and-gun shooter inspired by Metal Slug.
  3. ## Setup
  4. > **Note:** CMake and OpenSSL are required.
  5. ### Windows
  6. The following tools are required:
  7. * CMake
  8. * Ninja
  9. * Clang
  10. > Set your `CC` environment variable to the full path of `clang-cl.exe`
  11. > Set your `CMAKE_MT` environment variable to the full path of `mt.exe`, which can be found on your Windows SDK
  12. > installation folder (usually `C:/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/mt.exe`)
  13. 1. Clone this repo.
  14. 2. Clone the repositories under `dependencies.txt` except for SDL2.
  15. 3. Unpack the **MSVC** archive under `dependencies` folder in this project's root. Rename the directory as `SDL2`.
  16. 4. Build the following dependencies first:
  17. - `portmidi`
  18. - `libwebsockets` (follow the [instructions on building LWS](https://libwebsockets.org/lws-api-doc-master/html/md_README_8build.html))
  19. 5. Build via CMake.
  20. ### macOS/*NIX
  21. 1. Clone this repo.
  22. 2. Clone the repositories under `dependencies.txt`, including SDL2.
  23. 3. Build the SDL, SDL_image, and SDL_ttf dependencies using the [build instructions for Linux/UNIX](https://wiki.libsdl.org/SDL2/Installation#linuxunix)
  24. or [build instructions for macOS](https://wiki.libsdl.org/SDL2/Installation#macos).
  25. > **Note:** You may need to download other tools to build the libraries:
  26. > - autoconf
  27. > - make
  28. > **Note:** Clone the submodules under SDL_ttf to download freetype and harfbuzz:
  29. >
  30. > ```shell
  31. > git submodule update --init --recursive
  32. > ```
  33. 4. For OpenSSL, simply run:
  34. ```shell
  35. ./Configure
  36. make
  37. make test
  38. ```
  39. 5. Build the following dependencies first:
  40. - `portmidi` (Linux needs [ALSA libraries](https://www.alsa-project.org/files/pub/lib/) to be compiled)
  41. - ALSA Lib requires `libtool` to be compiled.
  42. - `libwebsockets` (follow the [instructions on building LWS](https://libwebsockets.org/lws-api-doc-master/html/md_README_8build.html))
  43. 6. Build via CMake.