Skip to content

Conversation

Liam-Weitzel
Copy link

My first nix package, a maplestory inspired cursor theme developed on nixos + sway. Likely works on x11 too.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • Nixpkgs 25.11 Release Notes (or backporting 25.05 Nixpkgs Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
  • NixOS 25.11 Release Notes (or backporting 25.05 NixOS Release notes)
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other contributing documentation in corresponding paths.

Add a 👍 reaction to pull requests you find important.

@nixpkgs-ci nixpkgs-ci bot added 12.first-time contribution This PR is the author's first one; please be gentle! 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. 9.needs: reviewer This PR currently has no reviewers requested and needs attention. labels Jul 9, 2025
Copy link
Contributor

@Iamanaws Iamanaws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other contributing documentation in corresponding paths.

Note that this package could not have sufficient relevance.

Before adding a new package

How realistic is it that it will be used by other people? It's good that nixpkgs caters to various niches, but if it's a niche of 5 people it's probably too small. A good estimate is checking upstream issues and pull requests, or other software repositories. Library packages should have at least one dependent.

Checkout NUR for personal packages

Comment on lines 44 to 52
meta = with lib; {
description = "Maplestory Cursor";
homepage = "https://github.com/Liam-Weitzel/maplestory-cursor";
license = licenses.gpl3Plus;
maintainers = with maintainers; [
liam-w
];
platforms = platforms.linux;
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
meta = with lib; {
description = "Maplestory Cursor";
homepage = "https://github.com/Liam-Weitzel/maplestory-cursor";
license = licenses.gpl3Plus;
maintainers = with maintainers; [
liam-w
];
platforms = platforms.linux;
};
meta = {
description = "Maplestory Cursor";
homepage = "https://github.com/Liam-Weitzel/maplestory-cursor";
license = lib.licenses.gpl3Plus;
maintainers = with lib.maintainers; [ liam-w ];
platforms = lib.platforms.linux;
};

src = fetchFromGitHub {
owner = "Liam-Weitzel";
repo = "maplestory-cursor";
rev = "main";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use tagged version or full commit hash

Suggested change
rev = "main";
rev = "ab043bdc2ee752141be89f6c4c4080c459d1243b";


stdenvNoCC.mkDerivation (finalAttrs: {
pname = "maplestory-cursor";
version = "1.0.0";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version not specified at all, use unstable versioning or assign a version in repo (version file, version as an attribute inside a file, as tag, ...)

Suggested change
version = "1.0.0";
version = "0-unstable-2025-07-09";

Comment on lines 14288 to 14293
liam-w = {
email = "liam.weitzel2@gmail.com";
github = "Liam-Weitzel";
githubId = 22010764;
name = "Liam Weitzel";
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how-to-become-a-maintainer

Split into a separate commit. Use the following commit message: maintainers: add <name>
Note that this commit must precede the package commit

@nixpkgs-ci nixpkgs-ci bot removed the 9.needs: reviewer This PR currently has no reviewers requested and needs attention. label Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. 12.first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants