material-maker: init at 1.3 #331491

aurreland · 2024-08-01T10:00:34Z

Description of changes

Material Maker is a Tool based on Godot Engine that can be used to create textures procedurally and paint 3D models.

https://www.materialmaker.org/

Things done

Add a 👍 reaction to pull requests you find important.

nixos-discourse · 2024-08-01T10:01:06Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/package-godot-projects-to-nixpkgs/49923/15

aurreland · 2024-08-01T14:00:31Z

Its running checks for darwin, I've not package it for darwin because i doesnt have a mac and it would be pointless as they could install it via a .dmg. Should i try to add darwin compatibity or maybe enable something so it doesnt bother about it ?

eljamm · 2024-08-01T14:07:12Z

If it can be done, I don't see why we shouldn't package this for mac as well. We should refactor the current derivation first, though, then we'll look into doing that.

I'm currently in the process if reviewing this, so you can expect my suggestions shortly.

By the way, perhaps it's best if you mark this PR as draft, since it's not ready to be merged.

d-brasher · 2024-08-01T14:14:05Z

pkgs/by-name/ma/material-maker/package.nix

+ meta = with lib; {
+ homepage = "https://www.materialmaker.org/";
+ description = "Tool based on Godot Engine that can be used to create textures procedurally and paint 3D models.";
+ license = licenses.mit;
+ platforms = [ "x86_64-linux" ];
+ maintainers = with maintainers; [ aurreland ];


Suggested change

meta = with lib; {

homepage = "https://www.materialmaker.org/";

description = "Tool based on Godot Engine that can be used to create textures procedurally and paint 3D models.";

license = licenses.mit;

platforms = [ "x86_64-linux" ];

maintainers = with maintainers; [ aurreland ];

meta = {

homepage = "https://www.materialmaker.org/";

description = "Tool based on Godot Engine that can be used to create textures procedurally and paint 3D models.";

license = lib.licenses.mit;

platforms = lib.platforms.x86_64-linux;

maintainers = with lib.maintainers; [ aurreland ];

See #208242

pkgs/by-name/ma/material-maker/package.nix

eljamm · 2024-08-01T14:15:52Z

pkgs/by-name/ma/material-maker/package.nix

+ pname = "material-maker";
+ version = "1.3";
+
+ src = if stdenv.isLinux then fetchurl {
+ url = "https://github.com/RodZill4/material-maker/releases/download/1.3/material_maker_1_3_linux.tar.gz";
+ hash = "sha256-Y8+ZwXy3zqnsxqqaZeVgFSxLzmUkq+rBzbq8tEDc8/g=";
+ } else throw "unsupported platform";


Use fetchzip instead of fetchurl since it auto-unpacks. We can also reuse the defined attributes like pname, version and versionUnderscore

Suggested change

pname = "material-maker";

version = "1.3";

src = if stdenv.isLinux then fetchurl {

url = "https://github.com/RodZill4/material-maker/releases/download/1.3/material_maker_1_3_linux.tar.gz";

hash = "sha256-Y8+ZwXy3zqnsxqqaZeVgFSxLzmUkq+rBzbq8tEDc8/g=";

} else throw "unsupported platform";

pname = "material-maker";

inherit version;

src =

if stdenv.isLinux then

fetchzip {

url = "https://github.com/RodZill4/${pname}/releases/download/${version}/material_maker_${versionUnderscore}_linux.tar.gz";

hash = "sha256-WEu5gVfnswB5zYzu3leOL+hKOBzJbn48gHQKshlfOh4=";

}

else

throw "unsupported platform";

pkgs/by-name/ma/material-maker/package.nix

eljamm · 2024-08-01T14:37:22Z

As a tip, you can batch commit multiple suggestions from the Files Changed tab, so you don't have to do it for each of them.

See Incorporating feedback in your pull request - GitHub Docs

aurreland · 2024-08-01T14:51:04Z

Thanks for the huge work eljamm and d-brasher, i will look into how we could add support for darwin.

eljamm · 2024-08-01T14:52:33Z

Since we're using finalAttrs, you'll have to precede every variable name that was defined inside the derivation with that. So:

${version} -> ${version} (stays version because we defined it in the let in block
${pname} -> ${finalAttrs.pname}
${meta.description} -> ${finalAttrs.meta.description}
...

aurreland · 2024-08-01T14:55:21Z

Good to know will change to this

eljamm · 2024-08-01T14:56:36Z

Just as a plus, since we're inheriting version in the derivation, we can also do ${finalAttrs.version}, but that won't work for versionUnderscore since it wasn't inherited.

pkgs/by-name/ma/material-maker/package.nix

aurreland · 2024-08-01T15:46:58Z

Should i pass it to ready now ?

eljamm · 2024-08-01T15:48:55Z

Not yet, we still need to add darwin support.

pkgs/by-name/ma/material-maker/package.nix

aurreland · 2024-08-01T15:54:23Z

How could we add support for darwin, because we are using binary do they work out of the box ? or should we try to remake the package to be compiled like lorien does ?

eljamm · 2024-08-01T15:58:00Z

If the platform is Darwin, we just copy the source to the Applications folder, as far as I know, at least.

aurreland · 2024-08-01T16:02:53Z

I will try tomorrow on an old mac i got, but i won't be able to do much till 24/08 as i am going on a vacation.

eljamm · 2024-08-01T16:11:27Z

Well, in that case you can open this PR for review because I think this is good enough to be merged.

If we can figure out how to package and test this on mac, then we'll include it here tomorrow, else we can add that in a separate PR if this gets merged first.

eljamm

LGTM

d-brasher · 2024-08-01T17:26:18Z

I think it could be a good thing to squash the commits in order to have just
maintainers: add aurreland (mind the s!) and material-maker: init at 1.3

See https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions

eljamm · 2024-08-01T17:32:35Z

I totally forgot about that 🤦

Thanks!

pkgs/by-name/ma/material-maker/package.nix

d-brasher · 2024-08-04T08:32:28Z

It now appears to miss a nixfmt pass (probably a trailing whitespace somewhere)

(if it can be of help, to squash commits I usually use git rebase --interactive [latest commit on master] and select all the commits to squash, this would prevent any merge conflict)

eljamm · 2024-08-04T09:55:52Z

pkgs/by-name/ma/material-maker/package.nix

+ ''
+ runHook preInstall
+ ''
+ + lib.optionalString stdenvNoCC.isLinux ''
+ install -D -m 755 $src/material_maker.x86_64 $out/opt/material-maker
+ install -D -m 644 $src/material_maker.pck $out/opt/material-maker.pck
+
+ for dir in library nodes environments meshes export; do
+ cp -R $src/$dir $out/opt
+ done
+
+ cp -R $src/examples $examples
+
+ mkdir -p $out/share/
+ cp -R $src/doc $out/share
+
+ install -D -m 644 $src/doc/_static/icon.png -t $out/share/icons/hicolor/256x256/apps/
+
+ mkdir -p $out/bin
+ ln -s $out/opt/material-maker $out/bin/material-maker
+ ''
+ + lib.optionalString (builtins.elem "doc" finalAttrs.meta.outputsToInstall && stdenvNoCC.isLinux) ''
+ ln -s $doc/share/doc $out/opt/doc
+ ''
+ +
+ lib.optionalString (builtins.elem "examples" finalAttrs.meta.outputsToInstall && stdenvNoCC.isLinux)
+ ''
+ ln -s $examples $out/opt/examples
+ ''
+ + lib.optionalString stdenvNoCC.isDarwin ''
+ mkdir -p $out/Applications
+ find ./ -type d -name "*.app" -exec cp -r {} /destination/directory $out/Applications \;
+ ''
+ + ''
+ runHook postInstall
+ '';


In my opinion, looping over getAllOutputNames is more readable.

Also, since the command that installs the icon also creates the $out/share directory, we can move cp -R $src/doc $out/share below that so we don't have to mkdir -p $out/share/

Suggested change

''

runHook preInstall

''

+ lib.optionalString stdenvNoCC.isLinux ''

install -D -m 755 $src/material_maker.x86_64 $out/opt/material-maker

install -D -m 644 $src/material_maker.pck $out/opt/material-maker.pck

for dir in library nodes environments meshes export; do

cp -R $src/$dir $out/opt

done

cp -R $src/examples $examples

mkdir -p $out/share/

cp -R $src/doc $out/share

install -D -m 644 $src/doc/_static/icon.png -t $out/share/icons/hicolor/256x256/apps/

mkdir -p $out/bin

ln -s $out/opt/material-maker $out/bin/material-maker

''

+ lib.optionalString (builtins.elem "doc" finalAttrs.meta.outputsToInstall && stdenvNoCC.isLinux) ''

ln -s $doc/share/doc $out/opt/doc

''

+

lib.optionalString (builtins.elem "examples" finalAttrs.meta.outputsToInstall && stdenvNoCC.isLinux)

''

ln -s $examples $out/opt/examples

''

+ lib.optionalString stdenvNoCC.isDarwin ''

mkdir -p $out/Applications

find ./ -type d -name "*.app" -exec cp -r {} /destination/directory $out/Applications \;

''

+ ''

runHook postInstall

'';

installPhase =

''

runHook preInstall

''

+ lib.optionalString stdenvNoCC.isLinux ''

install -D -m 755 $src/material_maker.x86_64 $out/opt/material-maker

install -D -m 644 $src/material_maker.pck $out/opt/material-maker.pck

for dir in library nodes environments meshes export; do

cp -R $src/$dir $out/opt

done

install -D -m 644 $src/doc/_static/icon.png -t $out/share/icons/hicolor/256x256/apps/

mkdir -p $out/bin

ln -s $out/opt/material-maker $out/bin/material-maker

cp -R $src/doc $out/share

cp -R $src/examples $examples

for output in $(getAllOutputNames); do

if [ "$output" == "doc" ]; then

ln -s $doc/share/doc $out/opt/doc

elif [ "$output" == "examples" ]; then

ln -s $examples $out/opt/examples

fi

done

''

+ lib.optionalString stdenvNoCC.isDarwin ''

mkdir -p $out/Applications

find ./ -type d -name "*.app" -exec cp -r {} /destination/directory $out/Applications \;

''

+ ''

runHook postInstall

'';

I added it but changed it so it queries outputsToInstall instead, i think this is wat it needs to follow, correct me if im wrong

Because if the user wants to only install the out and not doc and examples they will override the meta.outputsToInstall because if you remove outputs it doesnt build anymore

eljamm · 2024-08-04T13:13:06Z

pkgs/by-name/ma/material-maker/package.nix

+ cp -r $src/doc $out/share
+ cp -r $src/examples $examples
+
+ for output in ${builtins.concatStringsSep " " finalAttrs.meta.outputsToInstall}; do


Suggested change

for output in ${builtins.concatStringsSep " " finalAttrs.meta.outputsToInstall}; do

for output in $(getAllOutputNames); do

As I understand it, meta.outputsToInstall is used for the default outputs, which isn't a problem here since doc and examples are in the default already.

However, we will typically change outputs, so we need to match all cases from that. Also, if meta.outputsToInstall changes, the package will be rebuilt, and we don't want that to happen as changes to meta shouldn't cause a rebuild.

Example, try to build with:

nix-build -E 'with import ./. {}; (material-maker.overrideAttrs { outputs = ["out" "doc"]; })'

If outputsToInstall = finalAttrs.outputs;: No problem since overriding outputs will also override outputsToInstall and everything works. However, this doesn't sound correct to me because outputsToInstall is the default and shouldn't depend on outputs.

If we pin outputsToInstall = [ "out" "doc" "examples" ];: This doesn't work since we're looping over outputsToInstall which has "examples", but the overriden outputs does not, and so the destination $examples will not exist.

eljamm · 2024-08-04T13:19:18Z

pkgs/by-name/ma/material-maker/package.nix

+ platforms = lib.platforms.darwin ++ (lib.intersectLists lib.platforms.linux lib.platforms.x86_64);
+ maintainers = with lib.maintainers; [ aurreland ];
+ mainProgram = "material-maker";
+ outputsToInstall = finalAttrs.outputs;


It might be better to specify the outputs directly, here:

Suggested change

outputsToInstall = finalAttrs.outputs;

outputsToInstall = [

"out"

"doc"

"examples"

];

If outputs change, that shouldn't change the default outputs, right?

So we should move

cp -r $src/doc $out/share cp -r $src/examples $examples

into the for loop ?

I was kinda thinking the same as well, sure.

pkgs/by-name/ma/material-maker/package.nix

eljamm

Thanks a lot @aurreland and @d-brasher for your amazing contributions.

This looks good to me 😁

d-brasher · 2024-08-04T14:40:38Z

Result of nixpkgs-review pr 331491 run on x86_64-linux 1

3 packages built:

material-maker
material-maker.doc
material-maker.examples

Also tested basic app functionality.

d-brasher

LGTM, too!

nixos-discourse · 2024-08-04T14:43:13Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/1881

pkgs/by-name/ma/material-maker/package.nix

aurreland · 2024-08-06T09:14:35Z

I think we can remove finalAttrs, I'll do it this evening if you don't see any problem.

aurreland · 2024-08-06T09:37:44Z

Its currently not being used in the package. And I don't know if it's useful to have it in. It's difficult to find good docs about it.

aurreland · 2024-08-06T09:42:13Z

And if we keep it, should we use less let in and more finalAttrs refs?

d-brasher · 2024-08-06T09:55:30Z

This issue is the only thing I can find about let in vs finalAttrs.
It appears to be debated, but finalAttrs has the advantage to allow easy overrides.

You could indeed drop the use of let in and move everything inside mkDerivation using finalAttrs (imho it would be better), but I am by no means an expert on this.

If you choose to keep the let in as is, I think you can remove finalAttrs.

aurreland · 2024-08-06T10:25:59Z

I'll look into moving everything into finalAttrs.

aurreland · 2024-08-06T16:44:18Z

Does this looks good to you ? I'll squash when its finalized

d-brasher · 2024-08-06T17:01:47Z

looks fine to me 👍

Co-Authored-By: d-brasher <175485311+d-brasher@users.noreply.github.com> Co-Authored-By: Fedi Jamoussi <Fedi.Jamoussi@protonmail.ch>

aurreland · 2024-08-06T17:10:29Z

We should be done this time

github-actions bot added the 8.has: maintainer-list (update) label Aug 1, 2024

NixOSInfra added the 12. first-time contribution label Aug 1, 2024

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Aug 1, 2024

aurreland marked this pull request as draft August 1, 2024 14:11

d-brasher suggested changes Aug 1, 2024

View reviewed changes

eljamm reviewed Aug 1, 2024

View reviewed changes

pkgs/by-name/ma/material-maker/package.nix Outdated Show resolved Hide resolved

eljamm reviewed Aug 1, 2024

View reviewed changes

pkgs/by-name/ma/material-maker/package.nix Outdated Show resolved Hide resolved

aurreland marked this pull request as ready for review August 1, 2024 16:12

eljamm approved these changes Aug 1, 2024

View reviewed changes

aurreland force-pushed the master branch from 396a07e to 49dbf1f Compare August 3, 2024 19:49

d-brasher reviewed Aug 3, 2024

View reviewed changes

pkgs/by-name/ma/material-maker/package.nix Outdated Show resolved Hide resolved

eljamm reviewed Aug 4, 2024

View reviewed changes

aurreland force-pushed the master branch 2 times, most recently from 27bfd22 to a1b6cfb Compare August 4, 2024 12:57

eljamm reviewed Aug 4, 2024

View reviewed changes

aurreland force-pushed the master branch from a1b6cfb to cd7d742 Compare August 4, 2024 14:05

eljamm reviewed Aug 4, 2024

View reviewed changes

pkgs/by-name/ma/material-maker/package.nix Outdated Show resolved Hide resolved

aurreland force-pushed the master branch from 8e0c81d to d465745 Compare August 4, 2024 14:21

eljamm approved these changes Aug 4, 2024

View reviewed changes

eljamm added the 12.approvals: 1 label Aug 4, 2024

d-brasher approved these changes Aug 4, 2024

View reviewed changes

d-brasher added 12.approvals: 2 and removed 12.approvals: 1 labels Aug 4, 2024

d-brasher reviewed Aug 5, 2024

View reviewed changes

pkgs/by-name/ma/material-maker/package.nix Show resolved Hide resolved

aurreland force-pushed the master branch from ff769c5 to 3ab25f5 Compare August 5, 2024 19:11

material-maker: init at 1.3

2ff37bd

Co-Authored-By: d-brasher <175485311+d-brasher@users.noreply.github.com> Co-Authored-By: Fedi Jamoussi <Fedi.Jamoussi@protonmail.ch>

aurreland force-pushed the master branch from eaa295f to 2ff37bd Compare August 6, 2024 17:10

wegank removed the 12.approvals: 2 label Aug 10, 2024

	for output in ${builtins.concatStringsSep " " finalAttrs.meta.outputsToInstall}; do
	for output in $(getAllOutputNames); do

material-maker: init at 1.3 #331491

Are you sure you want to change the base?

material-maker: init at 1.3 #331491

Conversation

aurreland commented Aug 1, 2024 • edited Loading

Description of changes

Things done

nixos-discourse commented Aug 1, 2024

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024 • edited Loading

d-brasher Aug 1, 2024

Choose a reason for hiding this comment

eljamm Aug 1, 2024

Choose a reason for hiding this comment

eljamm commented Aug 1, 2024

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024 • edited Loading

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024

aurreland commented Aug 1, 2024

eljamm commented Aug 1, 2024

eljamm left a comment

Choose a reason for hiding this comment

d-brasher commented Aug 1, 2024

eljamm commented Aug 1, 2024

d-brasher commented Aug 4, 2024

eljamm Aug 4, 2024 • edited Loading

Choose a reason for hiding this comment

aurreland Aug 4, 2024

Choose a reason for hiding this comment

aurreland Aug 4, 2024

Choose a reason for hiding this comment

eljamm Aug 4, 2024 • edited Loading

Choose a reason for hiding this comment

eljamm Aug 4, 2024

Choose a reason for hiding this comment

aurreland Aug 4, 2024

Choose a reason for hiding this comment

eljamm Aug 4, 2024 • edited Loading

Choose a reason for hiding this comment

eljamm left a comment

Choose a reason for hiding this comment

d-brasher commented Aug 4, 2024 • edited Loading

d-brasher left a comment

Choose a reason for hiding this comment

nixos-discourse commented Aug 4, 2024

aurreland commented Aug 6, 2024

aurreland commented Aug 6, 2024

aurreland commented Aug 6, 2024

d-brasher commented Aug 6, 2024

aurreland commented Aug 6, 2024

aurreland commented Aug 6, 2024

d-brasher commented Aug 6, 2024

aurreland commented Aug 6, 2024

aurreland commented Aug 1, 2024 •

edited

Loading

eljamm commented Aug 1, 2024 •

edited

Loading

eljamm commented Aug 1, 2024 •

edited

Loading

eljamm Aug 4, 2024 •

edited

Loading

eljamm Aug 4, 2024 •

edited

Loading

eljamm Aug 4, 2024 •

edited

Loading

d-brasher commented Aug 4, 2024 •

edited

Loading