For build-site authors

Add Build Planner exports to your site

Your site supplies the build data; these encoders handle the GBP1: format. Start with a working form, copy the parts you need, and let players paste the result straight into the add-on.

JavaScript, Python, and PHP produce the same code

Pick your stack

The output is identical. The integration guide includes working patterns for React, Angular, Vue, and WordPress.

JavaScript

The simplest option for a form that already runs in the browser. The same file also works in Node.

Good fit: static sites, interactive build pages, and JavaScript applications.

Runs in
Browser or Node
Packages
None
Generator
GBP1.encodeBuild()

Python

Use the encoder in a backend or script. The demo runs that same Python file in the browser with Pyodide.

Good fit: Python services, build databases, automation, and offline tools.

Runs in
Browser or Python 3
Live demo
Pyodide via CDN
Generator
encode_build()

PHP

A plain server-rendered example with no framework and no Composer packages to install.

Good fit: shared hosting, existing PHP sites, and regular form posts.

Runs in
PHP 7.3+
Packages
None
Generator
gbpEncodeBuild()

At a glance

If you are unsure, start with JavaScript. It needs the least setup for a browser-based build editor.

Language Best fit Form behavior Server required
JavaScript Static sites and browser apps Updates immediately in the browser No
Python Backends, scripts, and automation Runs Python in the browser through WebAssembly No for the browser example
PHP PHP sites and shared hosting Submits a server-rendered form Yes

Run it locally

Each ZIP includes the encoder, a working form, and the build JSON used by the demo.

JavaScript

Unzip it and serve the folder with any static web server. The form fetches the example JSON beside it.

javascript/
  app.js
  gbp1.js
  index.html
example-build.json
example.css

Python

The browser demo works on static hosting. For local Python work, the ZIP also includes a small test server.

cd python
python example.py
# http://127.0.0.1:8081

PHP

Point a PHP server at the extracted folder, then submit the form normally.

cd php
php -S 127.0.0.1:8080
# http://127.0.0.1:8080
1. Read the formPut the player's choices into the documented build object.
2. Make the codeGive that object to the encoder and keep the returned GBP1: string.
3. Send it to the add-onThe player pastes the code into Build Planner's Share or Import window.