Compile files for NSP generation with hacbrewpack (#93)

Closes #91.

.changeset/config.json

@@ -8,6 +8,7 @@
   "fixed": [
     [
       "@nx.js/nro",
+      "@nx.js/nsp",
       "create-nxjs-app",
       "nxjs-runtime"
     ]

.changeset/tidy-timers-begin.md

@@ -0,0 +1,5 @@
+---
+'@nx.js/nsp': patch
+---
+
+Add `@nx.js/nsp` package

.github/workflows/ci.yml

@@ -84,6 +84,9 @@ jobs:
       - name: Copy `nxjs.nro` to "@nx.js/nro"
         run: cp -v nxjs.nro packages/nro/dist
 
+      - name: Copy files to "@nx.js/nsp"
+        run: cp -rv build/exefs nxjs.nacp icon.jpg packages/nsp
+
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

.gitignore

@@ -4,6 +4,9 @@ node_modules
 /lib/*/lib
 /lib/*/debug
 /lib/*/release
+/hacbrewpack_*
+/exefs
+/control
 
 /nxjs.*
 !/nxjs.jpg

Makefile

@@ -15,6 +15,7 @@ include $(DEVKITPRO)/libnx/switch_rules
 # SOURCES is a list of directories containing source code
 # DATA is a list of directories containing data files
 # INCLUDES is a list of directories containing header files
+# EXEFS_SRC is the optional input directory containing data copied into exefs, if anything this normally should only contain "main.npdm".
 # ROMFS is the directory containing data to be added to RomFS, relative to the Makefile (Optional)
 #
 # NO_ICON: if set to anything, do not use icon.
@@ -28,25 +29,21 @@ include $(DEVKITPRO)/libnx/switch_rules
 #     - <Project name>.jpg
 #     - icon.jpg
 #     - <libnx folder>/default_icon.jpg
-#
-# CONFIG_JSON is the filename of the NPDM config file (.json), relative to the project folder.
-#   If not set, it attempts to use one of the following (in this order):
-#     - <Project name>.json
-#     - config.json
-#   If a JSON file is provided or autodetected, an ExeFS PFS0 (.nsp) is built instead
-#   of a homebrew executable (.nro). This is intended to be used for sysmodules.
-#   NACP building is skipped as well.
 #---------------------------------------------------------------------------------
+
 APP_TITLE   :=  nx.js
 APP_TITLEID :=  016e782e6a730000 # 6e782e6a73 is "nx.js" in hex 😉
 APP_AUTHOR  :=  TooTallNate
 APP_VERSION :=  `jq -r .version < ../packages/runtime/package.json`
+
 TARGET		:=	nxjs
 BUILD		:=	build
 SOURCES		:=	source
 DATA		:=	data
 INCLUDES	:=	include
+EXEFS_SRC	:=	exefs_src
 ROMFS		:=	romfs
+CONFIG_JSON	:=	npdm.json
 
 #---------------------------------------------------------------------------------
 # options for code generation
@@ -58,10 +55,10 @@ CFLAGS	:=	-g -Wall -O2 -ffunction-sections \
 
 CFLAGS	+=	$(INCLUDE) -D__SWITCH__ `freetype-config --cflags` `aarch64-none-elf-pkg-config cairo --cflags`
 
-CXXFLAGS	:= $(CFLAGS) -fno-rtti -fno-exceptions
+CXXFLAGS	:=	$(CFLAGS) -fno-rtti -fno-exceptions
 
 ASFLAGS	:=	-g $(ARCH)
-LDFLAGS	=	-specs=$(DEVKITPRO)/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map)
+LDFLAGS	=	-specs=${DEVKITPRO}/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map)
 
 LIBS	:=  -pthread -lmbedtls -lmbedx509 -lmbedcrypto -lharfbuzz `freetype-config --libs` `aarch64-none-elf-pkg-config cairo --libs` -lturbojpeg -lwebp -lqjs -lm3 -lm
 
@@ -117,18 +114,7 @@ export INCLUDE	:=	$(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \
 
 export LIBPATHS	:=	$(foreach dir,$(LIBDIRS),-L$(dir)/lib)
 
-ifeq ($(strip $(CONFIG_JSON)),)
-	jsons := $(wildcard *.json)
-	ifneq (,$(findstring $(TARGET).json,$(jsons)))
-		export APP_JSON := $(TOPDIR)/$(TARGET).json
-	else
-		ifneq (,$(findstring config.json,$(jsons)))
-			export APP_JSON := $(TOPDIR)/config.json
-		endif
-	endif
-else
-	export APP_JSON := $(TOPDIR)/$(CONFIG_JSON)
-endif
+export BUILD_EXEFS_SRC := $(TOPDIR)/$(EXEFS_SRC)
 
 ifeq ($(strip $(ICON)),)
 	icons := $(wildcard *.jpg)
@@ -159,6 +145,19 @@ ifneq ($(ROMFS),)
 	export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS)
 endif
 
+ifeq ($(strip $(CONFIG_JSON)),)
+	jsons := $(wildcard *.json)
+	ifneq (,$(findstring $(TARGET).json,$(jsons)))
+		export APP_JSON := $(TOPDIR)/$(TARGET).json
+	else
+		ifneq (,$(findstring config.json,$(jsons)))
+			export APP_JSON := $(TOPDIR)/config.json
+		endif
+	endif
+else
+	export APP_JSON := $(TOPDIR)/$(CONFIG_JSON)
+endif
+
 .PHONY: $(BUILD) clean all
 
 #---------------------------------------------------------------------------------
@@ -171,11 +170,7 @@ $(BUILD):
 #---------------------------------------------------------------------------------
 clean:
 	@echo clean ...
-ifeq ($(strip $(APP_JSON)),)
-	@rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf
-else
-	@rm -fr $(BUILD) $(TARGET).nsp $(TARGET).nso $(TARGET).npdm $(TARGET).elf
-endif
+	@rm -fr $(BUILD) $(TARGET).pfs0 $(TARGET).nso $(TARGET).nro $(TARGET).nacp $(TARGET).elf $(TARGET).npdm
 
 
 #---------------------------------------------------------------------------------
@@ -187,26 +182,22 @@ DEPENDS	:=	$(OFILES:.o=.d)
 #---------------------------------------------------------------------------------
 # main targets
 #---------------------------------------------------------------------------------
+all	: $(OUTPUT).pfs0 $(OUTPUT).nro
+
 ifeq ($(strip $(APP_JSON)),)
+$(OUTPUT).pfs0	:	$(OUTPUT).nso
+else
+$(OUTPUT).pfs0	:	$(OUTPUT).nso $(OUTPUT).npdm
+endif
 
-all	:	$(OUTPUT).nro
+$(OUTPUT).nso	:	$(OUTPUT).elf
 
 ifeq ($(strip $(NO_NACP)),)
 $(OUTPUT).nro	:	$(OUTPUT).elf $(OUTPUT).nacp
 else
 $(OUTPUT).nro	:	$(OUTPUT).elf
 endif
 
-else
-
-all	:	$(OUTPUT).nsp
-
-$(OUTPUT).nsp	:	$(OUTPUT).nso $(OUTPUT).npdm
-
-$(OUTPUT).nso	:	$(OUTPUT).elf
-
-endif
-
 $(OUTPUT).elf	:	$(OFILES)
 
 $(OFILES_SRC)	: $(HFILES_BIN)

apps/2048/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/2048/package.json

@@ -5,15 +5,17 @@
   "description": "nx.js port of the 2048 game",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 src/main.js --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "dependencies": {
     "nxjs-constants": "workspace:*"
   },
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/ansi/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/ansi/package.json

@@ -5,12 +5,14 @@
   "description": "nx.js app with colors and cursor movement using ANSI escapes",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   },
   "dependencies": {

apps/app-launch/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/app-launch/package.json

@@ -5,12 +5,14 @@
   "description": "List and launch installed games",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 --format=esm src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/battery/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/battery/package.json

@@ -5,12 +5,14 @@
   "description": "nx.js app to display the battery charge level",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 --format=esm src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/canvas/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/canvas/package.json

@@ -5,12 +5,14 @@
   "description": "nx.js app using the web `Canvas` API",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/fonts/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/fonts/package.json

@@ -5,12 +5,14 @@
   "description": "nx.js app using customs fonts",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/hello-world/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/hello-world/package.json

@@ -5,12 +5,14 @@
   "description": "Simple 'Hello World' nx.js app",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 --format=esm src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/repl-server/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/repl-server/package.json

@@ -5,16 +5,18 @@
   "description": "nx.js REPL (read-eval-print-loop) app accessed over TCP",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 --format=esm src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "dependencies": {
     "@nx.js/repl": "workspace:^",
     "sisteransi": "^1.0.5"
   },
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/repl/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map

apps/repl/package.json

@@ -5,16 +5,18 @@
   "description": "nx.js REPL (read-eval-print-loop) app",
   "scripts": {
     "build": "esbuild --bundle --sourcemap --sources-content=false --target=es2022 src/main.ts --outfile=romfs/main.js",
-    "nro": "nxjs-nro"
+    "nro": "nxjs-nro",
+    "nsp": "nxjs-nsp"
   },
   "license": "MIT",
   "dependencies": {
     "kleur": "^4.1.5",
     "sisteransi": "^1.0.5"
   },
   "devDependencies": {
-    "esbuild": "^0.17.19",
     "@nx.js/nro": "workspace:^",
+    "@nx.js/nsp": "workspace:^",
+    "esbuild": "^0.17.19",
     "nxjs-runtime": "workspace:^"
   }
 }

apps/snake/.gitignore

@@ -1,4 +1,5 @@
 /*.nro
+/*.nsp
 /node_modules
 /romfs/main.js
 /romfs/main.js.map