dwarf-fortress: TWBT & Lazy Pack #43081

Baughn · 2018-07-05T19:12:26Z

Motivation for this change

The DF directory menaces with spikes of Nix code. It's difficult for a new user to know how to use it.

This adds dwarf-fortress-full, an admittedly opinionated configuration that should suffice as a starting point, and may suffice in general.

It also adds the TWBT plugin to dfhack, which makes text look nicer in general.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

matthewbauer · 2018-07-05T19:37:04Z

pkgs/games/dwarf-fortress/lazy-pack.nix

+    ++ lib.optional enableDwarfTherapist [ dwarf-therapist ]
+    ++ lib.optional enableLegendsBrowser [ legends-browser ];
+
+  meta = with stdenvNoCC.lib; {


You can just do with lib here.

matthewbauer · 2018-07-05T19:38:21Z

pkgs/games/dwarf-fortress/twbt/default.nix

@@ -0,0 +1,35 @@
+{ stdenvNoCC, fetchurl, unzip }:


This is kind of a nitpick but I prefer to just use stdenv & put stdenv = stdenvNoCC;.

Whether or not it needs the compiler is a property of the TWBT package, no? Not its caller. There is no use in overriding that parameter.

Oh yes that's make sense. Would it be difficult to make it build from source? They provide a CMakeFiles.txt that looks pretty simple.

They haven't tagged their releases, so I wouldn't know which git reference to use. I don't think we'd gain anything from compiling from source, either?

It would make it more portable. For instance "twbt.plug.so" is compiled for x86_64-linux. Someone might want to compile a version for i686-linux as well - or something besides linux. We also frequently hit issues where the linked libc.so or libgcc.so are not the same version on the system so it hits an issue (especially on NixOS where things are not always in the right place).

All right, but we still don't have release tags. I'll raise the issue with the author; in the meantime, I'll edit this commit to include 32-bit linux as an option. Kind of forgot that people still use that.

Ok yeah I would say for now it's okay - just definitely possible to improve it later on.

matthewbauer · 2018-07-05T19:41:20Z

pkgs/games/dwarf-fortress/lazy-pack.nix

+  # This package should, at any given time, provide an opinionated "optimal"
+  # DF experience. It's the equivalent of the Lazy Newbie Pack, that is, and
+  # should contain every utility available.
+, enableDFHack ? true


I might be wrong but I think if you set this to stdenv.isLinux this will support macOS out of the box. I'll need to test to verify though.

Actually I think a few of the wrappers might still be broken.

You might have an older version. I noticed I'd used lib.optional wrongly, which broke the legends-browser and dwarf-therapist packages.

There's still a few places we assume linux actually but I think we're closer:

https://github.com/NixOS/nixpkgs/blob/master/pkgs/games/dwarf-fortress/dwarf-therapist/wrapper.nix#L6

But I think it's closer. I tried to get dfhack working on macOS but it was more difficult than I thought.

matthewbauer · 2018-07-05T19:43:09Z

This would be very useful! If it works well I think it would be useful to just set dwarf-fortress = dwarf-fortress-packages.dwarf-fortress-full; in all-packages.nix.

Baughn · 2018-07-05T19:49:35Z

I've updated TWBT to the new version of DF, and it at least builds now, but I'm getting warnings because it's not intended for this version of DFHack. It's the newest version available, though.

matthewbauer · 2018-07-05T21:54:28Z

Ok after #43085 you should be able to do (dwarf-fortress-original.override ({ dfVersion = "0.44.10"; }))

matthewbauer · 2018-07-06T14:55:31Z

pkgs/games/dwarf-fortress/dfhack/default.nix

@@ -33,40 +34,47 @@ let
    fi
  '';

-in stdenv.mkDerivation rec {
-  name = "dfhack-${version}";
+  dfhack = stdenv.mkDerivation rec {


Okay this might be better to leave dfhack as is & create a "wrapper.nix" file to contain the buildEnv stuff.

You're the guy with commit access, but IMO these two derivations are logically grouped, so it should be fine to keep them in the same file. Changes to one may well require changes to the other.

Ok probably okay for now just. Is the PR okay to merge or are there still issues?

It should be fine to merge, but won't work well until I can rework it based on the other one. I'll leave that decision up to you.

Closes #43081

Baughn changed the title ~~Nix df~~ dwarf-fortress: TWBT & Lazy Pack Jul 5, 2018

GrahamcOfBorg added the 2.status: merge conflict label Jul 5, 2018

dwarf-fortress: Init TWBT at 6.46

5012ce7

GrahamcOfBorg removed the 2.status: merge conflict label Jul 5, 2018

Baughn force-pushed the nix-df branch 3 times, most recently from abf490a to 5d6186f Compare July 5, 2018 19:39

GrahamcOfBorg added 8.has: package (new) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Jul 5, 2018

Baughn mentioned this pull request Jul 5, 2018

dwarf-fortress: 0.44.10 -> 0.44.11 #42554

Merged

9 tasks

matthewbauer reviewed Jul 5, 2018

View reviewed changes

dwarf-fortress: Add "lazy pack", config flags and some comments.

b0c7245

Baughn force-pushed the nix-df branch from 5d6186f to b0c7245 Compare July 5, 2018 19:49

GrahamcOfBorg added 10.rebuild-darwin: 1-10 and removed 10.rebuild-darwin: 0 labels Jul 5, 2018

matthewbauer reviewed Jul 6, 2018

View reviewed changes

matthewbauer closed this Jul 9, 2018

matthewbauer merged commit b0c7245 into NixOS:master Jul 9, 2018

matthewbauer added a commit that referenced this pull request Jul 9, 2018

Merge pull request #43081 into master

2bb4088

Closes #43081

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dwarf-fortress: TWBT & Lazy Pack #43081

dwarf-fortress: TWBT & Lazy Pack #43081

Baughn commented Jul 5, 2018 •

edited

matthewbauer Jul 5, 2018

matthewbauer Jul 5, 2018

Baughn Jul 5, 2018

matthewbauer Jul 6, 2018

Baughn Jul 6, 2018

matthewbauer Jul 6, 2018

Baughn Jul 6, 2018

matthewbauer Jul 6, 2018

matthewbauer Jul 5, 2018

matthewbauer Jul 5, 2018

Baughn Jul 5, 2018

matthewbauer Jul 5, 2018

matthewbauer commented Jul 5, 2018

Baughn commented Jul 5, 2018 •

edited

matthewbauer commented Jul 5, 2018

matthewbauer Jul 6, 2018

Baughn Jul 6, 2018

matthewbauer Jul 6, 2018

Baughn Jul 6, 2018

dwarf-fortress: TWBT & Lazy Pack #43081

dwarf-fortress: TWBT & Lazy Pack #43081

Conversation

Baughn commented Jul 5, 2018 • edited

Motivation for this change

Things done

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

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

matthewbauer commented Jul 5, 2018

Baughn commented Jul 5, 2018 • edited

matthewbauer commented Jul 5, 2018

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

Baughn commented Jul 5, 2018 •

edited

Baughn commented Jul 5, 2018 •

edited