Install FunscriptForge¶

Your journey: Get a funscript → Install → Load your script → Read your assessment → Select phrases → Apply transforms → Preview → Export

Overview¶

This step gets FunscriptForge running on your machine. You will download the app, launch it, and confirm that it opens correctly in your browser. The whole process takes about two minutes.

FunscriptForge runs as a local web app — it opens in your browser, but all processing happens on your computer. Nothing is uploaded anywhere.

Why do this first¶

You cannot do anything else in this guide until the app is installed and running. This step has no prerequisites.

What to expect: Download is ~150 MB. First launch takes 5–10 seconds while the app starts up. After that, launches are fast.

Prerequisites¶

A computer running Windows 10/11, macOS 10.15+, or Linux (x86-64)
4 GB RAM minimum (8 GB recommended)
A modern browser (Chrome or Edge recommended; Firefox and Safari work)
A .funscript file you want to work on — you will need this in the next step

Don't have a funscript yet? The overview page explains where funscripts come from and what tools create them. Come back here once you have one.

Steps¶

1. Download FunscriptForge¶

Go to the FunscriptForge releases page and download the file for your operating system:

Operating system	File to download
Windows 10 / 11	`FunscriptForge-windows.zip`
macOS	`FunscriptForge-macos.zip`
Linux (x86-64)	`FunscriptForge-linux.tar.gz`

TODO: insert screenshot — GitHub Releases page with download buttons highlighted

2. Extract the app¶

Windows: Right-click FunscriptForge-windows.zip → Extract All… → choose a folder you can find again, for example C:\Program Files\FunscriptForge\ or your Desktop.

macOS: Double-click the zip. You will get FunscriptForge.app. Drag it to your Applications folder.

Linux:

tar -xzf FunscriptForge-linux.tar.gz
cd FunscriptForge

3. Launch the app¶

Windows: Double-click FunscriptForge.exe inside the extracted folder. A terminal window may flash briefly — that is normal.

macOS — first launch only: macOS will block an unsigned app on the first open. Right-click (or Control-click) FunscriptForge.app → Open → click Open in the dialog that appears. This is a one-time step. After the first approval you can double-click normally.

If macOS says the app is "damaged", open Terminal and run:
xattr -cr /Applications/FunscriptForge.app
Then try launching again.

Linux:

./FunscriptForge

4. Confirm it opened¶

Within 5–10 seconds your default browser should open automatically to the FunscriptForge app. You will see the main interface with a sidebar and a chart area.

TODO: insert screenshot — the app open in browser, empty state (no funscript loaded yet)

If the browser does not open automatically, go to http://localhost:6789 manually.

You should see¶

A browser window open to http://localhost:6789 showing the FunscriptForge interface. The sidebar on the left has a file path input. The main area says something like "No funscript loaded" or shows a blank chart.

If you see this — you are done. The app is running.

What you did¶

You downloaded FunscriptForge, extracted it, and launched it. The app is now running as a local server on your machine. Your browser is the interface — you can bookmark http://localhost:6789 if you want a shortcut for next time.

FunscriptForge stays running in the background as long as the terminal / launcher window is open. Close that window to shut the app down.

Something not working? Troubleshoot installing FunscriptForge →

Next step¶

Load your first funscript →

You might be wondering¶

Ask your own question →


System requirements	Full hardware and OS compatibility details
What is FunscriptForge?	The big picture before you dive in

flowchart LR
    A[Get a funscript] --> B[Install]:::here
    B --> C[Load your script]
    C --> D[Read your assessment]
    D --> E[Select phrases]
    E --> F[Apply transforms]
    F --> G[Preview]
    G --> H[Export]
    classDef here fill:#6c63ff,color:#fff,stroke:#6c63ff