vvvvvv: init at 2.3-git-2020-11-22 #79068

anna328p · 2020-02-02T03:28:31Z

Adds a package for VVVVVV, a platform game based on inverting gravity.

Motivation for this change

Adds the game VVVVVV to nixpkgs.

Things done

Notes

Fixed version of #78319 which was broken after a bad merge into my nixpkgs fork.

sikmir · 2020-02-02T10:50:40Z

Could you please squash commits into one?

pkgs/games/vvvvvv/default.nix

nh2 · 2020-02-02T17:30:03Z

For reference, this is a replacement for the previous PR #78319.

CCing people who commented there so they don't miss out on notifications: @leo60228 @jakobrs

leo60228 · 2020-02-02T18:47:28Z

Should there not be separate pkgs.vvvvvvMakeAndPlay and pkgs.vvvvvvFull attributes?

jakobrs · 2020-02-02T19:17:35Z

Idea: If someone implements the ability to load data.zip from a custom location, the binary could be factored out into a separate derivation, which might be redistributable.

/nix/store/...-data.zip             definitely unfree
/nix/store/...-vvvvvv-full-bin-...  unfreeRedistributable
/nix/store/...-vvvvvv-full-...      unfree, I think

The last of the three derivations would simply be a wrapper script that calls vvvvvv-bin with the right assets.

#!/bin/sh
${vvvvvvBin}/bin/VVVVVV --assets ${dataZip}

leo60228 · 2020-02-02T19:32:06Z

I can do this when I get home in about 30 minutes.

jakobrs · 2020-02-02T19:35:34Z

On the legal side of things:

@TerryCavanagh, are you OK with us redistributing the full-version binary without redistributing the assets?

leo60228 · 2020-02-02T21:05:00Z

diff --git a/desktop_version/src/FileSystemUtils.cpp b/desktop_version/src/FileSystemUtils.cpp
index 2a1d2df..a7db5ca 100644
--- a/desktop_version/src/FileSystemUtils.cpp
+++ b/desktop_version/src/FileSystemUtils.cpp
@@ -39,7 +39,7 @@ void PLATFORM_getOSDirectory(char* output);
 void PLATFORM_migrateSaveData(char* output);
 void PLATFORM_copyFile(const char *oldLocation, const char *newLocation);
 
-int FILESYSTEM_init(char *argvZero)
+int FILESYSTEM_init(char *argvZero, char *dataPath)
 {
 	char output[MAX_PATH];
 	int mkdirResult;
@@ -79,9 +79,7 @@ int FILESYSTEM_init(char *argvZero)
 	}
 
 	/* Mount the stock content last */
-	strcpy(output, PHYSFS_getBaseDir());
-	strcat(output, "data.zip");
-	if (!PHYSFS_mount(output, NULL, 1))
+	if (!PHYSFS_mount(dataPath, NULL, 1))
 	{
 		puts("Error: data.zip missing!");
 		puts("You do not have data.zip!");
diff --git a/desktop_version/src/FileSystemUtils.h b/desktop_version/src/FileSystemUtils.h
index d3c551e..404896b 100644
--- a/desktop_version/src/FileSystemUtils.h
+++ b/desktop_version/src/FileSystemUtils.h
@@ -6,7 +6,7 @@
 
 #include "tinyxml.h"
 
-int FILESYSTEM_init(char *argvZero);
+int FILESYSTEM_init(char *argvZero, char *dataPath);
 void FILESYSTEM_deinit();
 
 char *FILESYSTEM_getUserSaveDirectory();
diff --git a/desktop_version/src/main.cpp b/desktop_version/src/main.cpp
index 4dba0fa..76c79f3 100644
--- a/desktop_version/src/main.cpp
+++ b/desktop_version/src/main.cpp
@@ -44,7 +44,7 @@ entityclass obj;
 
 int main(int argc, char *argv[])
 {
-    if(!FILESYSTEM_init(argv[0]))
+    if(!FILESYSTEM_init(argv[0], argv[1]))
     {
         return 1;
     }
@@ -55,9 +55,9 @@ int main(int argc, char *argv[])
         SDL_INIT_GAMECONTROLLER
     );
 
-    if (argc > 2 && strcmp(argv[1], "-renderer") == 0)
+    if (argc > 3 && strcmp(argv[2], "-renderer") == 0)
     {
-        SDL_SetHintWithPriority(SDL_HINT_RENDER_DRIVER, argv[2], SDL_HINT_OVERRIDE);
+        SDL_SetHintWithPriority(SDL_HINT_RENDER_DRIVER, argv[3], SDL_HINT_OVERRIDE);
     }
 
     NETWORK_init();

jakobrs · 2020-02-02T21:07:56Z

Remember that you’ll probably want to make sure that that can be merged into upstream, as otherwise this package will have to be marked as modified.

From the license:

Altered source/binary versions must be plainly marked as such, and must not be misrepresented as being the original software.

Edit: What I mean is that it is important that the syntax is compatible with the old invocation syntax, as otherwise it probably won’t be merged into VVVVVV itself.

leo60228 · 2020-02-02T21:15:53Z

TerryCavanagh/VVVVVV#139

TerryCavanagh · 2020-02-02T21:36:02Z

@jakobrs Yep, it's fine to distribute the full version binary without the data.zip assets included.

jonringer

please squash the commits as well please:

git reset HEAD^^^
git add pkgs/
git commit --amend --no-edit
git push .. .. --forcce

leo60228 · 2020-02-02T23:29:05Z

The PR adding -assets was just merged.

anna328p · 2020-02-02T23:39:09Z

Should there not be separate pkgs.vvvvvvMakeAndPlay and pkgs.vvvvvvFull attributes?

can't that be done in all-packages.nix?

vvvvvvFull = callPackage ../games/vvvvvv { fullGame = true };

anna328p · 2020-02-02T23:42:22Z

here's the problem:

the officially distributed data.zip is the same as the Make and Play Edition data.zip, they have the same hash. the only difference between these two versions of the game is the flags used to build the game. if -DMAKEANDPLAY is set then the game runs in the Make and Play mode.

if the binary version is distributed with the make and play flag disabled, you can use the zip from the make and play version to play the game. therefore, if you have the full game, you must supply the zip yourself and the binary is built locally as it is not allowed to be redistributed. if you do not have the full game, you get the make and play binary which can be redistributed with the make and play zip (again, this is the same as the standard zip)

anna328p · 2020-02-02T23:42:48Z

Could you please squash commits into one?

Doesn't Github have an option to automatically do that when merging a pull request?

leo60228 · 2020-02-03T01:21:22Z

Doesn't Github have an option to automatically do that when merging a pull request?

Yes, but it doesn't follow the commit naming scheme used for nixpkgs.

jakobrs · 2020-02-03T06:39:45Z

That problem (with the Make and Play edition using the same zip file) already exists:

nix-env -iA nixpkgs.vvvvvv      # Fetches the data.zip for you
nix-env -iA nixpkgs.vvvvvvFull  # Uses the data.zip fetched in the previous step

The obvious solution is either not to fetch the data.zip in either case, or somehow change the hash of the data.zip file.

anna328p · 2020-02-03T11:54:27Z

That problem (with the Make and Play edition using the same zip file) already exists:
nix-env -iA nixpkgs.vvvvvv      # Fetches the data.zip for you
nix-env -iA nixpkgs.vvvvvvFull  # Uses the data.zip fetched in the previous step
The obvious solution is either not to fetch the data.zip in either case, or somehow change the hash of the data.zip file.

This problem already exists outside nixpkgs though; anyone can take the publicly available source and the publicly available make and play edition data.zip, and compile a complete version of the game.

leo60228 · 2020-02-03T12:44:35Z

Maybe have fetchurl rename the Make & Play data.zip so they have different hashes?

leo60228 · 2020-02-03T12:47:07Z

We could also do postFetch = "echo nixpkgs | zip -z $out";.

leo60228 · 2020-02-03T12:53:17Z

Yep, this seems to work:

let
  dataZip = if fullGame then requireFile {                                                                                                   
    # the data file for the full game                                                                                                        
    name = "data.zip";                                                                                                                       
    sha256 = "1q2pzscrglmwfgdl8yj300wymwskh51iq66l4xcd0qk0q3g3rbkg";                                                                         
    message = ''                                                                                                                             
      In order to install VVVVVV, you must first download the game's                                                                         
      data file (data.zip) as it is not released freely.                                                                                     
      Once you have downloaded the file, place it in your current                                                                            
      directory, use the following command and re-run the installation:                                                                      
      nix-prefetch-url file://\$PWD/data.zip                                                                                                 
    '';                                                                                                                                      
  } else fetchurl {                                                                                                                          
    # the data file for the free Make and Play edition                                                                                       
    url = https://thelettervsixtim.es/makeandplay/data.zip;                                                                                  
    sha256 = "0vnb4zyzp8jpayxrgs6mw98wxpcpqdcfx04j1g5s0hm378xwmxm6";                                                                         
    postFetch = "echo nixpkgs | ${zip}/bin/zip -z $out";                                                                                     
  };

leo60228 · 2020-02-03T13:02:45Z

@TerryCavanagh The license only applies to the binaries, right? That would make this hack of adding a zip file comment to the Make & Play data.zip so it has a different hash allowed. That's necessary because Nix treats files with the same name and hash as being the same file, so there's otherwise no way to distribute the Make & Play data.zip without also distributing the full game's data.zip. As a demonstration of this problem:

nix-env -iA nixos.vvvvvvFull # errors, no data.zip
nix-env -iA nixos.vvvvvv # downloads binaries and data.zip
nix-env -iA nixos.vvvvvvFull # succeeds, downloads binaries and uses data.zip already on system

Adding a zip file comment while downloading data.zip would cause it to have a different hash, solving this problem. This clause is worrying me:

Altered source/binary versions must be plainly marked as such, and must not be misrepresented as being the original software.

anna328p · 2020-07-29T02:59:26Z

Actually, v2.3's release date got bumped to October 1st.

The current master branch of the repository builds cleanly and has some substantial feature improvements over version 2.2. I'll bump the package to the latest revision and make the changes required to separate the full game and Make and Play Mode.

Adds a package for VVVVVV, a platform game based on inverting gravity.

- changed version to be a date instead of a fragment of the commit id - quoted homepage url - if user does not own the full game, build the redistributable "make and play version" instead - using sourceRoot instead of manually changing directory

jonringer · 2020-08-05T05:04:37Z

pkgs/games/vvvvvv/default.nix

+    homepage = "https://thelettervsixtim.es";
+    license = if fullGame then licenses.unfree else licenses.unfreeRedistributable;
+    maintainers = [ maintainers.dkudriavtsev ];
+    platforms = [ platforms.linux platforms.darwin ];


this makes [[string]] we want [string]

Suggested change

platforms = [ platforms.linux platforms.darwin ];

platforms = platforms.linux ++ platforms.darwin;

jonringer · 2020-08-05T05:11:28Z

pkgs/games/vvvvvv/default.nix

+    SDL2 SDL2_mixer
+  ] + stdenv.lib.optionalPlatform stdenv.lib.platforms.darwin [ Foundation ];
+
+    sourceRoot = "source/desktop_version";


Suggested change

sourceRoot = "source/desktop_version";

sourceRoot = "source/desktop_version";

jonringer · 2020-08-05T05:18:00Z

pkgs/games/vvvvvv/default.nix

+  nativeBuildInputs = [ cmake ninja ];
+  buildInputs = [
+    SDL2 SDL2_mixer
+  ] + stdenv.lib.optionalPlatform stdenv.lib.platforms.darwin [ Foundation ];


optionalPlatform doesn't exist, i think you want

Suggested change

] + stdenv.lib.optionalPlatform stdenv.lib.platforms.darwin [ Foundation ];

] + stdenv.lib.optionals stdenv.hostPlatform.isDarwin [ Foundation ];

jonringer · 2020-08-05T05:19:59Z

pkgs/games/vvvvvv/default.nix

+  };
+
+  # if the user does not own the full game, build the Make and Play edition
+  flags = if fullGame then [] else [ "-DMAKEANDPLAY" ];


Suggested change

flags = if fullGame then [] else [ "-DMAKEANDPLAY" ];

flags = lib.optionals fullGame [ "-DMAKEANDPLAY" ];

SuperSandro2000 · 2020-11-29T05:02:56Z

pkgs/games/vvvvvv/default.nix

+    '';
+  } else fetchurl {
+    # the data file for the free Make and Play edition
+    url = https://thelettervsixtim.es/makeandplay/data.zip;


Is there a versioned link?

data.zip has never changed since it was first introduced in 2014. Due to compatibility and the fact that this is an 11-year-old game, it probably won't ever be changed either. (But new zips will probably be introduced.)

SuperSandro2000

Also please squash the commits together and address the reviewer feedback.

anna328p · 2020-11-29T08:28:45Z

I plan on completely reworking this PR once 2.3 releases.

leo60228 · 2020-11-29T16:29:19Z

I'm pretty sure that due to the requireFile and fetchurl having the same hash the requireFile will just get the data.zip from the binary cache without prompting the user.

anna328p · 2020-11-30T02:02:43Z

I'm pretty sure that due to the requireFile and fetchurl having the same hash the requireFile will just get the data.zip from the binary cache without prompting the user.

Is there no way to have a license-restricted requireFile?

SuperSandro2000 · 2020-12-27T23:01:47Z

pkgs/top-level/all-packages.nix

@@ -24712,6 +24712,8 @@ in
    libpng = libpng12;
  };

+  vvvvvv = callPackage ../games/vvvvvv { };


Suggested change

vvvvvv = callPackage ../games/vvvvvv { };

vvvvvv = callPackage ../games/vvvvvv {

inherit (darwin.apple_sdk.frameworks) Foundation;

};

stale · 2021-06-26T00:12:00Z

I marked this as stale due to inactivity. → More info

anna328p · 2021-06-26T02:28:58Z

Still planning to work on this as soon as 2.3 releases.

dasJ · 2021-09-01T21:29:09Z

2.3.1 is released now

anna328p · 2021-09-11T22:56:58Z

Just saw this. I plan to work on this

Mic92 · 2022-12-18T08:36:02Z

Closing because of lack of activity from the author. Please re-open if you plan to work on this.

This was referenced Feb 2, 2020

vvvvvv: init at 2.3-git-2a514b2 #78319

Closed

[Third Party] Traditional (and Sandboxed ?) Packaging Checklist TerryCavanagh/VVVVVV#20

Closed

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Feb 2, 2020

sikmir reviewed Feb 2, 2020

View reviewed changes

pkgs/games/vvvvvv/default.nix Outdated Show resolved Hide resolved

jonringer reviewed Feb 2, 2020

View reviewed changes

anna328p force-pushed the vvvvvv branch from 3e128c7 to d121fd2 Compare February 2, 2020 23:33

anna328p force-pushed the vvvvvv branch from 262ca79 to 871c831 Compare July 29, 2020 02:56

anna328p and others added 6 commits July 28, 2020 21:28

vvvvvv: init at 2.3-git-2a514b2

4dbd8c5

Adds a package for VVVVVV, a platform game based on inverting gravity.

vvvvvv: fix packaging issues

514a302

- changed version to be a date instead of a fragment of the commit id - quoted homepage url - if user does not own the full game, build the redistributable "make and play version" instead - using sourceRoot instead of manually changing directory

vvvvvv: allow redistributing make&play edition

7666983

vvvvvv: fix version and bump to 2020-02-02

02a8417

vvvvvv: bump to 2020-02-09 to fix build errors

3332e86

added wrapper and renamed Make and Play data file

b9f9877

anna328p force-pushed the vvvvvv branch from 871c831 to b9f9877 Compare July 29, 2020 04:28

jonringer reviewed Aug 5, 2020

View reviewed changes

SuperSandro2000 reviewed Nov 29, 2020

View reviewed changes

SuperSandro2000 requested changes Nov 29, 2020

View reviewed changes

anna328p marked this pull request as draft November 29, 2020 08:29

SuperSandro2000 reviewed Dec 27, 2020

View reviewed changes

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 26, 2021

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 26, 2021

SuperSandro2000 added 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md and removed 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md labels Jun 26, 2021

leo60228 mentioned this pull request Nov 5, 2021

SDL2: 2.0.14 -> 2.0.20 #136166

Merged

11 tasks

SuperSamus mentioned this pull request Jun 3, 2022

vvvvvv: init at 2.3.6 #176140

Merged

13 tasks

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jul 10, 2022

Mic92 closed this Dec 18, 2022

	platforms = [ platforms.linux platforms.darwin ];
	platforms = platforms.linux ++ platforms.darwin;

	sourceRoot = "source/desktop_version";
	sourceRoot = "source/desktop_version";

	] + stdenv.lib.optionalPlatform stdenv.lib.platforms.darwin [ Foundation ];
	] + stdenv.lib.optionals stdenv.hostPlatform.isDarwin [ Foundation ];

	flags = if fullGame then [] else [ "-DMAKEANDPLAY" ];
	flags = lib.optionals fullGame [ "-DMAKEANDPLAY" ];

vvvvvv: init at 2.3-git-2020-11-22 #79068

vvvvvv: init at 2.3-git-2020-11-22 #79068

Conversation

anna328p commented Feb 2, 2020

Motivation for this change

Things done

Notes

sikmir commented Feb 2, 2020

nh2 commented Feb 2, 2020

leo60228 commented Feb 2, 2020

jakobrs commented Feb 2, 2020 • edited

leo60228 commented Feb 2, 2020

jakobrs commented Feb 2, 2020 • edited

leo60228 commented Feb 2, 2020

jakobrs commented Feb 2, 2020 • edited

leo60228 commented Feb 2, 2020

TerryCavanagh commented Feb 2, 2020

jonringer left a comment

Choose a reason for hiding this comment

leo60228 commented Feb 2, 2020

anna328p commented Feb 2, 2020

anna328p commented Feb 2, 2020

anna328p commented Feb 2, 2020

leo60228 commented Feb 3, 2020

jakobrs commented Feb 3, 2020

anna328p commented Feb 3, 2020 • edited

leo60228 commented Feb 3, 2020

leo60228 commented Feb 3, 2020

leo60228 commented Feb 3, 2020 • edited

leo60228 commented Feb 3, 2020

anna328p commented Jul 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuperSandro2000 left a comment

Choose a reason for hiding this comment

anna328p commented Nov 29, 2020

leo60228 commented Nov 29, 2020

anna328p commented Nov 30, 2020

Choose a reason for hiding this comment

stale bot commented Jun 26, 2021

anna328p commented Jun 26, 2021

dasJ commented Sep 1, 2021

anna328p commented Sep 11, 2021

Mic92 commented Dec 18, 2022

jakobrs commented Feb 2, 2020 •

edited

jakobrs commented Feb 2, 2020 •

edited

jakobrs commented Feb 2, 2020 •

edited

anna328p commented Feb 3, 2020 •

edited

leo60228 commented Feb 3, 2020 •

edited