mpo/VVVVVV
1
0
Fork 0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-11-16 07:59:43 +01:00
Code Issues Releases Wiki Activity
VVVVVV/desktop_version/README.md

75 lines
3.1 KiB
Markdown
Raw Normal View History

Hello WWWWWWorld!
2020-01-01 21:29:24 +01: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
Update to SDL 2.24.0 This updates all references to SDL 2.0.22 to SDL 2.24.0, including the Docker container that I maintain for Linux CI. Be warned, this release of SDL updates the versioning scheme to be less dumb. The previous version is 2.0.22, this release is 2.24.0 (so the last number can be properly used for patch-level version releases).
2022-08-22 01:07:51 +02:00
The engine depends solely on [SDL2](https://libsdl.org/) 2.24.0+. All other dependencies
Clarify dev libs line
2020-01-10 18:14:37 +01:00
are statically linked into the engine. The development libraries for Windows can
README: Minor adjustments to dependencies text
2022-03-25 00:28:03 +01:00
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.
`README.md`: Link to #618 for old Ubuntu versions While we can't fix Canonical, we can at least work around them, and help people on Ubuntu out by linking them to my comment listing the currently-known workarounds.
2021-11-14 19:11:33 +01:00
(If you're on Ubuntu and your Ubuntu is too old to have this SDL version, then
[see here](https://github.com/TerryCavanagh/VVVVVV/issues/618#issuecomment-968338212)
for workarounds.)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
Clarify submodules in desktop_version/README.md VVVVVV uses submodules now, so you need to know how to initialize them. I'm explicitly not including `git clone --recurse-submodules`. Usage of submodules in git projects is kinda rare in my experience, so people are used to doing simple clones, and that instruction would just result in people being annoyed thinking they have to delete the repo they already cloned, and clone it again except slightly differently. It also doesn't help you if you need submodules that aren't in the master branch (for example, if you clone my fork recursively and then checkout the localization branch, you won't have C-HashMap and you'll need the update command anyway). And you also need it whenever VVVVVV updates its submodules. So teaching people just the update command is better.
2022-10-16 15:19:40 +02:00
Since VVVVVV 2.4, git submodules are used for the
[third party libraries](https://github.com/TerryCavanagh/VVVVVV/tree/master/third_party).
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.
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
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.
Clarify references to Make and Play in README Some people might be confused by the reference to M&P in the instructions referring to downloading data.zip (#1026). data.zip is the same between M&P and full versions of the game and is orthogonal to which version of the game is built. Building M&P just requires uncommenting `#define MAKEANDPLAY` in `MakeAndPlay.h`. So clarify that you can grab data.zip from your existing copy of the game, or from the Make and Play _page_ (not necessarily the Make and Play edition of the game), and add instructions for building the M&P version. Closes #1027.
2023-10-26 01:47:25 +02:00
To build the Make and Play edition of the game, uncomment `#define MAKEANDPLAY`
in `MakeAndPlay.h`.
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
To generate the projects on Windows:
```
Port to FAudio
2022-03-09 22:35:29 +01:00
# Put your SDL2 folders somewhere nice!
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
mkdir flibitBuild
cd flibitBuild
Update to SDL 2.24.0 This updates all references to SDL 2.0.22 to SDL 2.24.0, including the Docker container that I maintain for Linux CI. Be warned, this release of SDL updates the versioning scheme to be less dumb. The previous version is 2.0.22, this release is 2.24.0 (so the last number can be properly used for patch-level version releases).
2022-08-22 01:07:51 +02:00
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"
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
```
Add note about Windows .lib weirdness
2020-01-13 04:36:57 +01:00
Note that on some systems, the `SDL2_LIBRARIES` list on Windows may need
Port to FAudio
2022-03-09 22:35:29 +01:00
SDL2/SDL2main to have `.lib` at the end of them. The reason for this
Add note about Windows .lib weirdness
2020-01-13 04:36:57 +01:00
inconsistency is unknown.
Add Visual Studio string list If people compile with VS 2019, then putting in VS 2010 will just result in a weird error that's not really indicative of anything.
2021-08-24 18:11:02 +02:00
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"`
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
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.
Update README.md
2020-01-10 19:28:27 +01:00
Including data.zip
------------
Clarify references to Make and Play in README Some people might be confused by the reference to M&P in the instructions referring to downloading data.zip (#1026). data.zip is the same between M&P and full versions of the game and is orthogonal to which version of the game is built. Building M&P just requires uncommenting `#define MAKEANDPLAY` in `MakeAndPlay.h`. So clarify that you can grab data.zip from your existing copy of the game, or from the Make and Play _page_ (not necessarily the Make and Play edition of the game), and add instructions for building the M&P version. Closes #1027.
2023-10-26 01:47:25 +02:00
You'll need the data.zip file from VVVVVV to actually run the game! You can grab
it from your copy of the game, or you can download it for free from the [Make
and Play](https://thelettervsixtim.es/makeandplay/) page. Put this file next to
your executable and the game should run.
Note location of data.zip
2020-01-10 19:39:18 +01:00
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](../LICENSE.md) for more details. (If
you've got a project in mind that requires distributing this
file, [get in touch](http://distractionware.com/email/)!)
Reference in a new issue Copy permalink