/RISE2023

An end-of-year project made in 2 weeks for school

Primary LanguageC++OtherNOASSERTION

2023 RISE Project

Notes

This project was developed on Windows 10 using MSYS2 (MinGW64). I tried as much as possible to make it work on Linux, but am unsure whether it'll work completely. I tested it on Debian 11 and 12 and it worked for me, but your mileage may vary.

  • SDL2 and its image/mixer libraries are available under the zlib license.
  • The Steamworks SDK is available under the Steamworks SDK Access Agreement.
  • More credits and license information can be found in CREDITS.md

This project has a LOT of issues, but with only around two weeks of time to work on it, it's fine. I plan on reworking a lot of this in the future, the product of which I hope to properly license.

Dependencies

Anything below with # next to it means that whatever method of obtaining it should work, but that I used the system package manager (MSYS2's pacman in my case).

Steamworks

This is a bit of an unknown legal area for me. I mean, so is licensing in general, but zlib and CC-BY are way easier to understand. Obtaining the Steamworks SDK requires an account and agreement to its license. I am fairly confident that my use of it is acceptable (see Distributing Open Source Applications on Steam, and this project specifically has been worked on mostly in an educational context.

The Steam Input API requires an IGA file be provided by the game developer. Unfortunately, I'm not paying $100 to put my game on Steam. In order to play the game on controller (which, as of now, is the only possible way), you need to place the custom IGA file into your Steam root directory. On Windows, usually this is C:\Program Files (x86)\Steam\. On Linux and OSX, I have no clue. In the Steam root, place the game_actions_480.vdf file into a folder called controller_config. If it doesn't exist, create it.