VVVVVV

mpo/VVVVVV

mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-12-22 17:49:43 +01:00

History

Misa e93d8989d3 Revert "Fix Secret Lab Time Trial trophies having wrong colors" As reported by Dav999, Victoria and Vermilion's trophy colors are swapped again in 2.4. He points to `37b7615b71`, the commit where I fixed the color masks of every single surface to always be RGB or RGBA. It sounded plausible to me, because it did have to do with colors, after all. However, it didn't make sense to me, because I was like, I didn't touch the trophy colors at all after I originally fixed them. After I ruled out the RGBf() function as a confounder, I decided to see whether intentionally reversing the color order in RGBf() to be BGR would do anything, and to my surprise it actually swapped the colors back around and it didn't actually look bad. And then I realized: Swapping the trophy colors between RGB and BGR ordering results in similar colors that still look good, but are simply wrong, but not so wrong that they take on a color that no crewmate uses, so it'd appear as if the crewmates were swapped, when in reality the only thing that was swapped was actually the color order of the colors. Trying to fix this by swapping the colors again, I actively confused colors 33 and 35 (Vermilion and Victoria) with colors 32 and 34 (Vitellary and Viridian), so I was confused when Vermilion and Victoria weren't swapping. Then as a debugging step, I only changed 34 to 32 without swapping 32 as well, and then finally noticed that I was swapping Vitellary and Viridian, because there were now two Vitellarys. And then I was reminded that Vitellary and Viridian were also wrongly swapped since 2.0 as well. And so then I finally realized: The original comments accompanying the colors were correct after all. The only problem was that they were fed into a function, RGBf(), that read the colors backwards, because the codebase habitually changed the color order on a whim and it was really hard to reason out which color order should be used at a given time, so it ended up reading RGB colors as BGR, while it looked like it was passing them through as-is. So what happened was that in the first place, RGBf() was swapping RGB to BGR. Then I came and swapped Vermilion and Victoria, and Vitellary and Viridian around. Then later I fixed all the color masks, so RGBf() stopped swapping RGB and BGR around. But then this ended up swapping the colors of Vermilion and Victoria, and Vitellary and Viridian once again! Therefore, swapping Vermilion and Victoria, and Vitellary and Viridian was incorrect. Or at least, not the fix to the root cause. The root cause would be to swap the colors in RGBf(), but this would be sort of confusing to reason about - at least if I didn't bother to just type the RGB values into an image editor. But that doesn't fix the real issue, which is that the game kept swapping RGB and BGR around in every corner of the codebase. I further confirmed that there was no more RGB or BGR swapping by deleting the plus-one-divide-by-three transformation in RGBf() and seeing if the colors looked okay. Now with the colors being brighter, I could see that passing it straight through looked fine, but intentionally reversing it to be BGR resulted in colors that at a distance looked okay, but were either washed out or too bright. At least finally I could use my 8 years of playing this game for something. So in conclusion, actually, `37b7615b71` ("Fix surface color masks") was the real fix, and `d271907f8c` ("Fix Secret Lab Time Trial trophies having wrong colors") was the real regression. It's just that the regression came first, but it wasn't really a regression until I did the other fix, so the fix isn't the regression, the regression is... this is hurting my brain. Or the real regression was the friends we made along the way, or something like that. This is the most trivial bug ever caused by the technical debt of those god-awful reversed color masks. --- This reverts commit `d271907f8c`. Fixes #862.		2022-02-12 00:41:02 -08:00
..
src	Revert "Fix Secret Lab Time Trial trophies having wrong colors"	2022-02-12 00:41:02 -08:00
.dockerignore	Run CI on CentOS 7 (#574 )	2021-01-11 00:30:15 -05:00
.gitignore	Don't recompile all files when the commit hash is changed	2020-12-25 20:17:01 -05:00
CMakeLists.txt	Consolidate SoundSystem into Music.	2021-12-26 08:38:19 -05:00
CONTRIBUTORS.txt	Update comments about contributor ordering	2021-08-24 09:42:23 -07:00
Dockerfile	Update `Dockerfile` to SDL 2.0.20	2022-02-11 17:31:41 -05:00
fixupMac.sh	Added my quick script to fixup Mac dylib paths	2021-09-01 12:07:57 -04:00
icon.ico	Updated .ico	2021-09-03 15:57:16 -04:00
icon.rc	Embedded .ico	2021-08-28 11:21:49 -04:00
README.md	Update `README.md` to refer to SDL 2.0.20	2022-02-11 17:31:41 -05:00
version.cmake	Untabify every single file	2021-09-06 18:56:39 -07:00

README.md

How to Build

VVVVVV's official desktop versions are built with the following environments:

Windows: Visual Studio 2010
macOS: Xcode CLT, currently targeting 10.9 SDK
GNU/Linux: CentOS 7

The engine depends solely on SDL2 2.0.20+ and SDL2_mixer. All other dependencies are statically linked into the engine. The development libraries for Windows can be downloaded from their respective websites, Linux developers can find the dev libraries from their respective repositories, and macOS developers should compile and install from source (including libogg/libvorbis/libvorbisfile). (If you're on Ubuntu and your Ubuntu is too old to have this SDL version, then see here for workarounds.)

Steamworks support is included and the DLL is loaded dynamically, you do not need the SDK headers and there is no special Steam or non-Steam version. The current implementation has been tested with Steamworks SDK v1.46.

To generate the projects on Windows:

# Put your SDL2/SDL2_mixer folders somewhere nice!
mkdir flibitBuild
cd flibitBuild
cmake -A Win32 -G "Visual Studio 10 2010" .. -DSDL2_INCLUDE_DIRS="C:\SDL2-2.0.20\include;C:\SDL2_mixer-2.0.4\include" -DSDL2_LIBRARIES="C:\SDL2-2.0.20\lib\x86\SDL2;C:\SDL2-2.0.20\lib\x86\SDL2main;C:\SDL2_mixer-2.0.4\lib\x86\SDL2_mixer"

Note that on some systems, the SDL2_LIBRARIES list on Windows may need SDL2/SDL2main/SDL2_mixer to have .lib at the end of them. The reason for this inconsistency is unknown.

Also note that if you're using a Visual Studio later than 2010, you will need to change the -G string accordingly; otherwise you will get a weird cryptic error. Refer to the list below:

VS 2012: "Visual Studio 11 2012"
VS 2013: "Visual Studio 12 2013"
VS 2015: "Visual Studio 14 2015"
VS 2017: "Visual Studio 15 2017"
VS 2019: "Visual Studio 16 2019"
VS 2022: "Visual Studio 17 2022"

To generate everywhere else:

mkdir flibitBuild
cd flibitBuild
cmake ..

macOS may be fussy about the SDK version. How to fix this is up to the whims of however Apple wants to make CMAKE_OSX_SYSROOT annoying to configure and retain each time Xcode updates.

Including data.zip

You'll need the data.zip file from VVVVVV to actually run the game! It's available to download separately for free in the Make and Play edition of the game. Put this file next to your executable and the game should run.

This is intended for personal use only - our license doesn't allow you to actually distribute this data.zip file with your own forks without getting permission from us first. See LICENSE.md for more details. (If you've got a project in mind that requires distributing this file, get in touch!)

A Word About Compiler Quirks

(Note: This section only applies to version 2.2 of the source code, which is the initial commit of this repository. Since then, much hard work has been put in to fix many undefined behaviors. If you're compiling the latest version of the source code, ignore this section.)

This engine is super fussy about optimization levels and runtime checks. In particular, the Windows version absolutely positively must be compiled in Debug mode, with /RTC enabled. If you build in Release mode, or have /RTC disabled, the game behaves dramatically different in ways that were never fully documented (bizarre softlocks, out-of-bounds issues that don't show up in tools like Valgrind, stuff like that). There are lots of things about this old code that could be cleaned up, polished, rewritten, and so on, but this is the one that will probably bite you the hardest when setting up your own build, regardless of platform.

We hope you'll enjoy messing with the source anyway!

Love, flibit