1
0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-06-28 07:28:30 +02:00
VVVVVV/desktop_version
Dav999-v d1f6c1adf2 Replace "by" for level authors with happy face
"by {author}" is a string that will cause a lot of localization-related
problems, which then become much worse when different languages and
levels can also need different fonts:

- If the author name is set to something in English instead of a name,
  then it'll come out a bit weird if your VVVVVV is set to a different
  language: "de various people", "por various people", etc. It's the
  same problem with Discord bots completing "playing" or "watching" in
  their statuses.

- Translators can't always fit "by" in two letters, and level creators
  have understandably always assumed, and will continue to assume, that
  "by" is two letters. So if you have your VVVVVV set to a language that
  translates "by" as something long, then:
  | by Various People and Others |
  ...may suddenly show up as something like:
  |thorer Various People and Othe|

- "by" and author may need mutually incompatible fonts. For example, a
  Japanese level in a Korean VVVVVV needs to be displayed with "by" in
  Korean characters and the author name with Japanese characters, which
  would need some very special code since languages may want to add
  text both before and after the name.

- It's very possible that some languages can't translate "by" without
  knowing the gender of the name, and I know some languages even
  inflect names in really interesting ways (adding and even replacing
  letters in first names, surnames, and anything in between, depending
  on gender and what else is in the sentence).

So to solve all of this, the "by" is now replaced by a 10x10 face from
sprites.png, like a :viridian: emote. See it as a kind of avatar next
to a username, to clarify and assert that this line is for the author's
name. It should be a fairly obvious/recognizable icon, it fixes all the
above problems, and it's a bonus that we now have more happy faces in
VVVVVV.
2023-02-13 23:27:00 -08:00
..
fonts Update readmes for new font system 2023-02-13 23:27:00 -08:00
lang Replace "by" for level authors with happy face 2023-02-13 23:27:00 -08:00
src Replace "by" for level authors with happy face 2023-02-13 23:27:00 -08:00
.dockerignore Run CI on CentOS 7 (#574) 2021-01-11 00:30:15 -05:00
.gitignore Optimize recompilation from changing commit hash 2022-08-23 00:00:38 -07:00
CMakeLists.txt Start rewrite of font system 2023-02-13 23:27:00 -08:00
CONTRIBUTORS.txt Move from surfaces to the SDL render system 2023-01-28 14:36:28 -08:00
Dockerfile Update to SDL 2.24.0 2022-08-21 16:07:51 -07:00
fixupMac.sh Remove SDL2_mixer line from fixupMac.sh 2022-03-29 02:27:15 -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 Clarify submodules in desktop_version/README.md 2022-10-16 09:56:34 -07:00
version.cmake Add branch name to interim version information 2023-01-07 19:18:28 -08:00

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.24.0+. All other dependencies are statically linked into the engine. The development libraries for Windows can be downloaded from SDL's website, Linux developers can find the dev libraries from their respective repositories, and macOS developers should compile and install from source. (If you're on Ubuntu and your Ubuntu is too old to have this SDL version, then see here for workarounds.)

Since VVVVVV 2.4, git submodules are used for the third party libraries. After cloning, run git submodule update --init to set all of these up. You can also use this command whenever the submodules need to be updated.

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 folders somewhere nice!
mkdir flibitBuild
cd flibitBuild
cmake -A Win32 -G "Visual Studio 10 2010" .. -DSDL2_INCLUDE_DIRS="C:\SDL2-2.24.0\include" -DSDL2_LIBRARIES="C:\SDL2-2.24.0\lib\x86\SDL2;C:\SDL2-2.24.0\lib\x86\SDL2main"

Note that on some systems, the SDL2_LIBRARIES list on Windows may need SDL2/SDL2main 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