Publishing the map

Publish turns the project’s edits into the server files: the OTBMs and the respawn, house and zone XMLs. Only the Editor and the Owner publish.

The Publish… button sits in the footer of the layers panel, next to “N unpublished changes”. Undoing does not count as a change in that number.

Step 1: choose and generate

The Publish changes dialog shows:

• Destination. With no destination configured, the publication generates a zip to download. The Owner can configure an SFTP destination: the Set up SFTP button asks for server, port, user, folder, and a password or key, and Test connection shows the server key’s fingerprint for you to confirm.
• Tiles that already exist go to their layer, with the count per layer.
• New tiles: the editor asks which layer to write them to, an existing one or a New layer. Layers whose name starts with # do not work, because the server ignores them. New towns, waypoints, houses and respawns also ask for the layer. A new zone goes to the main map. The Remember the choice in this project checkbox keeps the layer.
• Map diagnostics (optional). Runs the problem scan on the whole map and counts errors and warnings. It does not block the publication.
• Version name (optional). For example, “Before the Halloween event”. The name appears in the versions list.

Generate files waits for the upload of your latest edits to finish, because the publication only sees what has already reached the server.

What is generated

Each publication starts from the imported files and applies the whole edit history, so it does not depend on earlier ones. The same edits give the same result.

• Only the layers with changes are generated. A file with no changes stays the same, byte for byte.
• A new layer becomes custom/<name>.otbm, with the four XMLs beside it: <name>-house.xml, <name>-monster.xml, <name>-npc.xml and <name>-zones.xml.
• An imported map goes out whole in the first publication that includes it, even without edits.
• The OTBM is only released after being checked against the server’s reading rules. If the server would not load the file, the publication fails and says why.
• If an erased tile would reveal, in the game, the tile from a lower layer, the summary warns you.

Step 2: follow and take it to the server

A publication runs on the Orbiz server. You can close the dialog: it keeps going, and the result stays in the list. The screen shows the queue, the current stage, the error in Portuguese if it fails, and Try again.

When it is ready, the result shows:

• What changed since the previous publication (or since the import), per layer: tiles, items, towns, waypoints, respawns, houses and zones.
• The list of files, with size and a standalone Download.
• Download zip. The paths are the server’s: extract at the root of the server folder and the files overwrite those with the same path.
• Write to the server folder… (Chrome and Edge only). Orbiz compares each file in the folder with what it has, does not rewrite what is already identical, and asks for confirmation for what changed outside Orbiz or does not exist in the folder. It checks the size and hash of what it downloaded, never deletes anything and stops at the first error.
• With an SFTP destination, Orbiz sends only the files that changed and keeps the previous version of each one in the destination’s bkp/ folder.

With no destination configured, nothing goes to the game server.

Previous publications

Orbiz keeps the 3 most recent ready publications of each project. They appear under Previous publications, with Open, and in the versions tab.

Only one publication runs at a time in each project. While it runs, you cannot upload new sources.