Merge pull request #57 from tumble1999/mod-framework

Mod framework

Author: MFDGaming

flake.lock

@@ -21,6 +21,10 @@
       flake = false;
       url = "github:nothings/stb/5736b15f7ea0ffb08dd38af21067c314d6a3aae9";
     };
+    ninecraft-mod-toolchain-build-scripts = {
+      flake = false;
+      url = "github:MCPI-Revival/ninecraft-mod-toolchain-build-scripts";
+    };
   };
 
   outputs = {
@@ -31,11 +35,15 @@
     glad,
     ancmp,
     stb,
+    ninecraft-mod-toolchain-build-scripts,
   }: let
     mkPkgs = system:
       import nixpkgs {
         inherit system;
-        config.allowUnfree = true;
+        config = {
+          allowUnfree = true;
+          android_sdk.accept_license = true;
+        };
         overlays = [nixgl.overlay];
       };
   in
@@ -45,11 +53,14 @@
       packages =
         (import ./nix/pkgs {
           inherit pkgs;
-          inherit glad stb ancmp;
+          flakeRoot = self;
+          # inherit glad stb ancmp ninecraft-mod-toolchain-build-scripts;
           # ancmp = ./ancmp;
         })
         // {
-          default = packages.ninecraft;
+          default = packages.buildNinecraftInstance {
+            version = packages.mcpeVersions.a0_6_1;
+          };
         };
       apps = {
         extract = {
@@ -58,9 +69,6 @@
         };
       };
       formatter = pkgs.alejandra;
-      devShell = pkgs.callPackage ./nix/shell.nix {
-        inherit (packages) ninecraft ninecraft-nixgl;
-      };
     })
     // {
       nixosModule = {pkgs, ...}: {

flake.nix

@@ -13,7 +13,7 @@ Please don't just blindly copy and paste the below, please [learn about nix flak
 {
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
-	 ninecraft = {
+   ninecraft = {
       url = "github:MCPI-Revival/Ninecraft";
       inputs.nixpkgs.follows = "nixpkgs";
     };
@@ -25,8 +25,8 @@ Please don't just blindly copy and paste the below, please [learn about nix flak
     nixosConfigurations = {
       # NOTE: change "host" to your system's hostname
       host = nixpkgs.lib.nixosSystem {
-		system = "x86_64-linux";
-		specialArgs = [ninecraft];
+    system = "x86_64-linux";
+    specialArgs = [ninecraft];
         modules = [
           ./configuration.nix
         ];
@@ -37,11 +37,11 @@ Please don't just blindly copy and paste the below, please [learn about nix flak
       user = lib.homeManagerConfiguration {
           extraSpecialArgs = moduleArgs;
 
-		specialArgs = [ninecraft];
+    specialArgs = [ninecraft];
         modules = [
           ./home.nix
         ];
-		system
+    system
       };
     };
   };
@@ -57,78 +57,120 @@ Please don't just blindly copy and paste the below, please [learn about nix flak
 ```nix
 {pkgs,lib,...}:
 {
-	imports = [
-		# without flakes
-		<ninecraft/nix/nixos>
-		#with flakes
-    	ninecraft.nixosModule
-	];
-
-	# ... other stuff
-
-	programs.ninecraft = {
-		enable = true;
-		openFirewall = true;
-	};
+  imports = [
+    # without flakes
+    <ninecraft/nix/nixos>
+    #with flakes
+      ninecraft.nixosModule
+  ];
+
+  # ... other stuff
+
+  programs.ninecraft = {
+    enable = true;
+    openFirewall = true;
+  };
 }
 ```
 
 ## HomeManager
+
 > home.nix
 
 This is a work in progress and many options may not function yet.
 
 ```nix
 {pkgs,lib,...}:
 {
-	imports = [
-		# without flakes
-		<ninecraft/nix/home>
-		#with flakes
-    	ninecraft.homeManagerModule
-	];
-
-	# ... other stuff
-
-	programs.ninecraft = {
-		enable = true;
-		version = "0.6.0";
-		#apk = fetchzip {
-			# 	url = "https://archive.org/download/MCPEAlpha/PE-a0.7.0-x86.apk"
-			# 	hash = lib.fakeHash;
-			# }
-		options = {
-			"mp_username"="Steve";
-			"mp_server"="Steve";
-			"mp_server_visible_default"=true;
-			"gfx_fancygraphics"=true;
-			"gfx_lowquality"=false;
-			"ctrl_sensitivity"=0.5
-			"ctrl_invertmouse"=false;
-			"ctrl_islefthanded"=false;
-			"ctrl_usetouchscreen"=false;
-			"ctrl_usetouchjoypad"=false;
-			"feedback_vibration"=false;
-			"game_difficulty"=4;
-		};
-		
-		#extracts into mod folder
-		mods = with pkgs; [
-			(fetchzip {
-				url = "example.com/mod.zip";
-				hash = lib.fakeHash;
-			})
-			(fetchgit {
-				url = "https://.../ok.git";
-				hash = lib.fakeHash;
-			})
-			(fetchFromGitHub {
-				owner = "a";
-				repo = "b";
-				rev = "main";
-				hash = lib.fakeHash;
-			})
-		]
-	}
+  imports = [
+    # without flakes
+    <ninecraft/nix/home>
+    #with flakes
+      ninecraft.homeManagerModule
+  ];
+
+  # ... other stuff
+
+  programs.ninecraft = {
+    enable = true;
+    version = "0.6.0";
+    #apk = fetchzip {
+      #   url = "https://archive.org/download/MCPEAlpha/PE-a0.7.0-x86.apk"
+      #   hash = lib.fakeHash;
+      # }
+    options = {
+      "mp_username"="Steve";
+      "mp_server"="Steve";
+      "mp_server_visible_default"=true;
+      "gfx_fancygraphics"=true;
+      "gfx_lowquality"=false;
+      "ctrl_sensitivity"=0.5
+      "ctrl_invertmouse"=false;
+      "ctrl_islefthanded"=false;
+      "ctrl_usetouchscreen"=false;
+      "ctrl_usetouchjoypad"=false;
+      "feedback_vibration"=false;
+      "game_difficulty"=4;
+    };
+    
+    #extracts into mod folder
+    mods = with pkgs; [
+      (fetchzip {
+        url = "example.com/mod.zip";
+        hash = lib.fakeHash;
+      })
+      (fetchgit {
+        url = "https://.../ok.git";
+        hash = lib.fakeHash;
+      })
+      (fetchFromGitHub {
+        owner = "a";
+        repo = "b";
+        rev = "main";
+        hash = lib.fakeHash;
+      })
+    ]
+  }
 }
-```
+```
+
+# Modding
+
+## Create Mod
+
+```nix
+with import <ninecraft/nix/pkgs> {}:
+buildNinecraftMod {
+  pname = "mymod";
+  version = "0.1.0";
+  src = ./src;
+}
+```
+```nix
+with import <ninecraft/nix/pkgs> {}:
+buildNinecraftMod {
+  pname = "mymod";
+  version = "0.1.0";
+  src = fetchurl {
+    url = "example.com/path/to/mod.zip";
+    hash = lib.fakeHash;
+  };
+  precompiled = true;
+  compiledX86 = "x86/mod.so";
+compiledArm = "arm/mod.so";
+}
+```
+
+```nix
+with import <nixpkgs> {};
+with import <ninecraft/nix/pkgs> {}:
+buildNinecraftMod {
+  pname = "mymod";
+  version = "0.1.0";
+  src = fetchurl {
+    url = "example.com/path/to/mod/${system}/mod.so";
+    hash = lib.fakeHash;
+  };
+  precompiled = true;
+}
+```

nix/README.md

@@ -0,0 +1,17 @@
+{
+  pkgs ?
+    import <nixpkgs> {
+      config = {
+        allowUnfree = true;
+        android_sdk.accept_license = true;
+      };
+    },
+  lib ? import ./lib.nix {inherit pkgs;},
+  ninecraftPkgs ? import ./pkgs {inherit pkgs;},
+}:
+ninecraftPkgs
+// {
+  inherit (lib) nixgl;
+  home = import ./home;
+  nixos = import ./nixos;
+}

nix/default.nix

@@ -2,45 +2,61 @@
   pkgs,
   config,
   lib,
+  osConfig ? null,
   ...
 }: let
   cfg = config.programs.ninecraft;
+  types = lib.types;
+  mkOptDef = default: lib.mkOption {inherit default;};
+  mkOptType = type: lib.mkOption {inherit type;};
+  mkOptNamed = options:
+    lib.mkOption {
+      default = {};
+      type = with types; attrsOf (submodule [{inherit options;}]);
+    };
 in {
-  options.programs.ninecraft = let
-    types = lib.types;
-  in {
+  options.programs.ninecraft = {
     enable = lib.mkEnableOption "Install Ninecraft";
-    version = lib.mkOption {
-      type = types.str;
-      default = "0.6.0";
-    };
     package = lib.mkOption {
       type = types.package;
-      default = with import ../pkgs {}; ninecraft;
+      default = pkgs.ninecraft;
     };
-    apk = lib.mkOption {
-      type = types.nullOr (types.package);
-    };
-    options = lib.mkOption {
-      type = types.attrsOf (types.oneOf [types.int types.bool types.str]);
-      default = {
-        "mp_username" = "Steve";
-        "mp_server" = "Steve";
-        "mp_server_visible_default" = true;
-        "gfx_fancygraphics" = true;
-        "gfx_lowquality" = false;
-        "ctrl_sensitivity" = 0.5;
-        "ctrl_invertmouse" = false;
-        "ctrl_islefthanded" = false;
-        "ctrl_usetouchscreen" = false;
-        "ctrl_usetouchjoypad" = false;
-        "feedback_vibration" = false;
-        "game_difficulty" = 4;
+    instances = mkOptNamed {
+      version = lib.mkOption {
+        type = types.str;
+        default = "0.6.1";
+      };
+
+      options = lib.mkOption {
+        default = null;
+        type =
+          types.nullOr (types.attrsOf (types.oneOf [types.int types.bool types.str]));
+      };
+      apk = lib.mkOption {
+        type = types.nullOr (types.package);
+        default = pkgs.mcpeVersions.a0_6_1;
+      };
+      mods = lib.mkOption {
+        type = types.listOf types.package;
+        default = [];
       };
     };
-    mods = lib.mkOption {
-      type = types.listOf types.package;
-      default = [];
-    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    nixpkgs.overlays = lib.mkIf (!(osConfig.home-manager.useGlobalPkgs or false)) [
+      (new: old: import ../. {pkgs = new;})
+    ];
+    home.packages = builtins.map (
+      name: let
+        inCfg = cfg.instances.${name};
+        version = inCfg.apk or pkgs.mcpeVersions."a${lib.replaceStrings ["."] ["_"] cfg.version}";
+      in
+        pkgs.buildNinecraftInstance (inCfg
+          // {
+            inherit name version;
+            homeDir = "~/.local/share/ninecraft/instances/${name}";
+          })
+    ) (builtins.attrNames cfg.instances);
   };
 }