Added executable file, updated paths and readme

Author: labmonkey

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build TypeScript
+        run: npm run build
+
+      - name: Bundle with esbuild
+        run: npm run build:bundle
+
+      - name: Generate SEA blob
+        run: npm run build:blob
+
+      - name: Copy Node executable to ssib.exe
+        run: npm run build:exe
+
+      - name: Inject SEA blob
+        run: npm run build:inject
+
+      - name: Upload exe to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ssib.exe
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}

.gitignore

@@ -1,3 +1,5 @@
 node_modules
-dist/*
-output/*
+build
+output
+*.exe
+*.blob

Readme.md

@@ -1,22 +1,36 @@
-### Satisfactory Signs Image Builder
+# Satisfactory Signs Image Builder
 
-This typescript script converts an JPG image into Satisfactory blueprint files that can be later build in the game and create a "poster" of your image. It is using the awesome [etothepii4/satisfactory-file-parser](https://github.com/etothepii4/satisfactory-file-parser) that made it possible.
+This tool converts an JPG image into Satisfactory blueprint files that can be later build in the game and create a "poster" of your image. It is using the awesome [etothepii4/satisfactory-file-parser](https://github.com/etothepii4/satisfactory-file-parser) that made it possible.
+
+This script creates a vanilla blueprint built from an array 1m Signs. It is not a mod, does not add anything extra to the game, works on local games as well as servers and should rather not be broken by any game updates (unless they change something with the Signs). The blueprint files can be easily shared with others just like other blueprints.
 
 **Take this project as it is. It was my fun proof of concept side project and I am not intending to maintain it. It is quite simple so it can be easily modified.**
 
-Example of 64x64 image built with 1m Signs:
+Example of an 64x64 image built with 1m Signs:
 
 ![Preview](preview.png "Example of 64x64 image")
 
-## How to build it
+## How to build the Blueprint files by using Windows executable
+
+1. Download the pre compiled [ssib.exe](http://github.com/labmonkey/satisfactory-signs-image-builder/releases/latest/download/ssib.exe) file.
+2. Prepare your image.  
+   This script supports only JPG, square images that have sizes that are divisible by 32 (32x32, 64x64, 128x128 etc).
+3. Open your terminal in the directory of the executable and type `./ssib.exe <NAME> <PATH>`, where:
+   - `NAME` is the desired name of the Blueprint in the game
+   - `PATH` is the path of your source image file. The resulting blueprints will be in the `output` directory.
+
+   For example `./ssib.exe DOGE ./assets/doge64.jpg`
+
+## How to build the Blueprint files by using NodeJS
+
+1. You will need NodeJS. Download it from [https://nodejs.org/en/download](https://nodejs.org/en/download). I recommend the latest LTS version.
+2. Prepare your image.  
+   This script supports only JPG, square images that have sizes that are divisible by 32 (32x32, 64x64, 128x128 etc).
+3. Build the project. Open your terminal in this project directory and type `npm run build` then run it by `npm start <NAME> <PATH>`, where:
+   - `NAME` is the desired name of the Blueprint in the game
+   - `PATH` is the path of your source image file. The resulting blueprints will be in the `output` directory.
 
-1. Prepare your image.  
-   This script supports only JPG, square images that have sizes are divisible by 32 so for example 32x32, 64x64, 128x128 etx. Easiest way is to place the image in the `assets` directory.
-1. Configure project.  
-   Go to `src/config.ts` and edit variables inside the `Configuration` section.  
-      - `imagePath`- Path to your image file. 
-      - `blueprintName` - Name of the output Blueprint files.
-2. Build the project `npm run build` and run it `npm start`
+   For example `npm start DOGE ./assets/doge64.jpg`
 
 ## How to add it to the game
 
@@ -26,20 +40,21 @@ Example of 64x64 image built with 1m Signs:
 
 ## How to build it in the game
 
-This script is splitting images in to sections that have sizes of 32x32 pixels (Which are 32x32 1m Signs in the game).
+This script is splitting images in to sections that have sizes of 32x32 pixels (Which is an array of 32x32 1m Signs in the game).
 
-Below is the layout of the way sections are created. Each section is named as `ROW x COLUMN` started from bottom left and going to top right. So for example with 6x64 image I will place Section 1x1 first, then 1x2 on the right side of it, then 2x1 on top of the 1x1 and so on.
+Below is the layout of the way sections are created. Each section is named as `ROW x COLUMN` started from bottom left and going to top right. So for example with 6x64 image you will place Section 1x1 first, then 1x2 on the right side of it, then 2x1 on top of the 1x1 and so on.
 
-| | Column 1| Column 2 | Column B ...|
-| --------- | ------- | ------- | ----- |
-| Row A ... |   Ax1   |   Ax2   |  AxB  |
-| Row 2     |   2x1   |   2x2   |  2xB  |
-| Row 1     |   1x1   |   1x2   |  1xB  |
+|           | Column 1 | Column 2 | Column B ... |
+| --------- | -------- | -------- | ------------ |
+| Row A ... |   Ax1    |   Ax2    |  AxB         |
+| Row 2     |   2x1    |   2x2    |  2xB         |
+| Row 1     |   1x1    |   1x2    |  1xB         |
 
 ## Few tips and notes about performance:
 
 - The Signs do not snap that well so it might be easier to build a huge wall behind and then try to align the blueprint sections with it.
-- Each section costs 1024 x Reinforced Iron Plate and 5120 x Quartz Crystal. This requires a lot of inventory space and is only possible to be built in later stages of the game hen you unlock more inventory slots.
-- I did not notice performance drops after the "Poster" was built but there were noticable drops while building it. 
+- Each section costs `1024 x Reinforced Iron Plate` and `5120 x Quartz Crystal`. This requires a lot of inventory space and is only possible to be built in later stages of the game when you unlock enough inventory slots (You need `37` slots).
+- I did not notice performance drops after the "Poster" of 64x64 was built. The bigger the image the worse it can get so be careful. 
 - While you place the blueprint the hologram will cause big FPS drop but it will go back to normal as soon as you exit build mode.
-- There is some limit of how many Signs are loaded at same time so after you build it or load the "Poster" for the first time you will see that the signs will be slowly loaded and their contents replaced 1 by 1. In my 64x64 image it took about 30 second before it was fully loaded for first time.
+- There is some limit of how many Signs are loaded at same time so after you build it or load the "Poster" by being around it you will see that the signs will be slowly loaded and their contents replaced 1 by 1. In my 64x64 image it took about 30 second before it was fully loaded for first time.
+- The games saves memory and the signs are unloaded when you leave the area of your "Poster". It will load again when you get back to it but then it will do it slowly as explained in point above. This means that if you often leave your base then it will spend most time trying to load rather than displaying full picture.