pixelforge-uploader
v2.4.0
Published
Local helper for the PixelForge Roblox Studio plugin: uploads captured icons to Roblox via Open Cloud, or saves them as transparent PNGs. Runs on your own machine, zero dependencies, your API key never leaves your computer.
Maintainers
Readme
PixelForge Uploader
The companion uploader for the PixelForge Roblox Studio plugin. It takes the icons you capture in Studio and either uploads them to Roblox (via Open Cloud) or saves them as transparent PNG files on your computer.
It runs on your own machine, with one command:
npx pixelforge-uploaderThat's it. No install, no account, no sign-up. Same command on Windows and macOS.
Is it safe to run?
Short answer: yes. Here is exactly why, so you don't have to take my word for it.
- It runs only on your computer. It opens a tiny local web server on
localhost(127.0.0.1:34890) that the Studio plugin talks to. It is not reachable from the internet. - Zero dependencies. It's plain Node.js (
http/https/zlib). There is nonode_modulestree to vet, nothing else gets downloaded. - It's one readable file. The whole program is a single
src.js(~700 lines) shipped right inside this package. Open it and read it, it's all there. - Your API key stays yours. It's saved locally at
~/.pixelforge-uploader/config.json(file permissions600) and is only ever sent straight to Roblox's official Open Cloud endpoint (apis.roblox.com) to do your uploads. It is never sent anywhere else. - No analytics, no telemetry, no background service. Nothing phones home. When you close the window, it stops.
What it does
Studio (PixelForge plugin) ──raw pixels over localhost──► this uploader
│
┌───────────────────┴───────────────────┐
▼ ▼
Upload to Roblox Save a PNG file
(Open Cloud, your key) (no key needed)The plugin can't upload images by itself (Roblox blocks that for Studio plugins), so it hands the finished pixels to this little helper, which encodes the PNG and does the upload from your own connection. Your key lives here, never in the plugin.
It also powers PixelForge's Mass Export, capturing a whole folder of models and saving / uploading them in one go.
Quick start
- Install Node.js 18 or newer (one time, free).
- In a terminal, run
npx pixelforge-uploader. - Follow the short first-run setup (or skip it to just save PNGs).
- Leave the window open, then capture and upload from PixelForge in Studio.
Just want to save PNGs and not upload? Answer "n" when it asks about uploading. Saving needs no API key. You can turn on uploading later from the menu.
First-run setup
A guided wizard asks for two things:
- An Open Cloud API key with the
asset:writescope. Create one (free) at https://create.roblox.com/dashboard/credentials: add the Assets API, tickasset:write, and set the IP address to0.0.0.0/0. - Where to upload: your account, or a group, plus its numeric id.
These are saved locally to ~/.pixelforge-uploader/config.json. You only do
this once.
The dashboard
While it runs in a terminal, it shows a clean status screen: whether it's running, where icons upload, where PNGs save, and your recent activity. A short numbered menu lets you change things without restarting; press the number:
When uploading is set up:
| Key | Action |
| --- | --- |
| 1 | Change your API key |
| 2 | Switch between your account and a group |
| 3 | Change the folder where PNGs are saved (opens a folder picker) |
| 4 | Test your API key (a safe check, uploads nothing) |
| q | Quit |
In save-only mode the menu is just 1 set up uploading, 2 change the save
folder, and q quit.
Saving PNGs
"Save PNG" in the plugin writes a transparent PNG straight to a folder, with no
API key and no upload. Files go to ~/Pictures/PixelForge by default; change
the folder from menu option 3. Mass Export drops each batch in its own
subfolder.
Options for power users
npx pixelforge-uploader reconfigurere-runs the setup wizard.- Environment variables (handy for scripts, these skip the dashboard):
PIXELFORGE_API_KEY,PIXELFORGE_CREATOR_TYPE(user/group),PIXELFORGE_CREATOR_ID,PIXELFORGE_SAVE_DIR,PIXELFORGE_PORT(default34890).
Need help?
- X / Twitter: https://x.com/juztripper
- Email: [email protected]
Made for PixelForge - Icon Tool.
