Everything you change in a game client is kept in a project, apart from the game, until you choose Install. Nothing you do in Studio changes the client or the server before that.
An MMO World is different: it is your own folder, so Save writes straight into it and there is no project and no Install. See MMO Worlds.
The unsaved project
The moment you open a client, Studio gives it an unsaved project to hold your work, and the top bar says Unsaved project. Saved maps, extracted files, recolored textures, imports and bakes all go into it. Open the same client again later and the same unsaved project comes back with your work.
When you want to keep it under a name, choose Save project as… in the top bar or the File menu (Ctrl + Shift + S) and type a name. Studio copies the project to Documents\GoMMO Studio\Projects\<name> and switches to it. The top bar then shows its name; hover over it to see the folder.
File > Open project… reopens a project and the client it was made for. File > Open project folder shows it in Explorer.
What a project holds
| folder | what is in it |
|---|---|
maps | your edited copy of each map you saved |
files\client | files that replace or add to the client's own, at the client's own paths |
files\server | the same for the linked server |
assets | imported models, built maps and baked lighting not yet installed |
baked | creatures and items you placed on a map as props, baked into model files |
backups | one folder per install, holding a copy of everything it replaced |
reverted | a copy of each project file you reverted in Review changes |
exports | spawn tables and map pictures you export |
logs | the logs of a server you run from the Server panel |
The files\client folder is read before the client's own files, everywhere in Studio. A texture you save there shows on the model at once, a file you extract from an archive lands there, and anything you drop into it yourself at the right path does the same. See Editing skins and hot reload.
A map you have saved opens from the project, with your changes, rather than from the client.
Installing
Install… in the top bar or the File menu works out exactly what changes and shows it before anything is written. At the top of the dialog, choose what it covers:
- Only … the map or document in focus: the map you are editing (and none of the project's files), or the script, NPC dialog, texture or game data you have open (just its files).
- Whole project: every map the project holds an edited copy of, open or not, and every file in the project's
filesfolders (game data, packs, scripts, textures, dialogs).
The project remembers the choice for next time. With a model or the world graph in focus there is nothing to install on its own, so the dialog covers the whole project. When only one item is chosen, the dialog lists what it leaves out.
The dialog shows the client folder and the linked server folder, then:
- Issues the game found. A warning is worth reading; anything that blocks must be fixed first, and the Install button reads Blocked until it is. Click an issue to select the object it is about.
- Files and records that change, each marked client or server, with the reason it changes and its size. On RF Online a map's spawns, NPCs and portals show as one row, placement rows of map …, marked server database.
Choose Install to write them. A file that already matches what Install would write is left alone, and the dialog says when there is nothing to write at all.
Server files are installed only while a server is linked; the dialog says how many it is leaving out. See Linking a server.
Close the game client before installing, so it does not hold its files open. The linked server can keep running: an RF Online server picks up a map's spawns, NPCs and portals by itself within a few seconds, and reads changed server files at its next start, which Test in game does for you. See Running the server.
Installing some of the changes
Review changes…, in the Install dialog and the File menu, lists every change the install makes with a tick beside each, all ticked to begin with. Untick the ones to leave out for now and choose Install N of M…: the Install dialog opens for the ticked changes only and names the ones left out. Opened from the Install dialog, the review starts with that dialog's choices, and Back to Install carries your ticks back.
An issue that belongs to a change you left out, or to a map none of whose ticked changes it makes, no longer blocks the rest. The review is also where you see each change's diff and take a change out of the project; see Reviewing every change.
When two maps change the same file
Some files hold more than one map: RF Online's client map table, a Gate to Heavens pack, a shared server file. A whole-project install that finds two maps changing one of these works each map's change out against the copy on disk and merges them, as long as they do not touch the same place:
- different lines of a text file;
- different parts of a binary file of the same size, a few bytes apart at least;
- different files inside a Gate to Heavens pack;
- different maps' entries in RF Online's client map table.
Two maps that both add lines at the end of the same text file touch the same place, so that clashes too, for example two RF Online maps that each add a row to the retail map list while Also write retail spawn files is on.
When the two changes overlap, the file blocks the install, and the issue shows the clash: the lines each map changes around the overlap, or the bytes each one writes with their place in the file, and which archive member, table or map entry they are in. The Review changes list marks that file clash and shows the same above its diff.
To get past a clash, untick that file in Review changes and install the rest, or install the two maps one at a time with Only …. On Gate to Heavens, two maps whose map files share one object list give the advice to make the object edits in one of the two maps instead, because the second map's install rewrites the objects from its own copy.
RF Online's map table also blocks when:
- both maps add a new map, since each would take the next map number;
- both change the same map's entry in different ways;
- both repaint their areas so that the area names table changes size, or the two changes land side by side;
- a new map installs beside another map's ore vein edit or rebuilt geometry;
- a map gets its first portal while the other map changes the portal it is copied from.
Backups
Every install first copies what it replaces into a folder of its own under the project's backups folder: client files, server files and, on RF Online, a map's rows in the server's database. If any write fails, everything already written is put back. The Install dialog names the folder when it finishes.
Keep the backups folder. Game data's Revert all reads it to find the original of each file the project installed; see Editing game data.
Putting an install back
Restore last install, at the bottom left of the Install dialog, puts back everything the newest install replaced, files and database rows alike, and removes what it added. It only restores into the client and server folders open now, and it backs up what it replaces like any install, so choosing it again undoes the restore.
An AI assistant can list every backup and restore an older one by name; see Working with an AI assistant.
Sharing a project with your team
Studio is for the people who build and run the server. Two entries in the File menu hand a project to another of them:
- Export project package… packs the whole project, its maps, files and game data edits, into one
.zip, for a teammate or another PC. Backups stay out, so the package stays small. The project must have a name first: choose Save project as on an unsaved one. - Open project package… opens such a
.zipas a new project in your projects folder and opens it. Studio checks every file against the list inside the package, so a damaged download is refused rather than opened. When the package is for the game you have open, it uses your client folder; link your own server in the Server panel if the project needs one.
Getting your changes to players
Players never open Studio and never apply a patch by hand. They get your client changes the way they get every update: the launcher. Your server's web server offers the install's client folder and its manifest.txt to every launcher, and each launcher downloads whatever differs from the player's copy before the game starts. See The launcher and Client updates for how that is set up.
The order is:
- Install puts the project into your own client and onto your server: map files, server files and database rows such as RF Online's game data and map placements. Players need the server side in place before the client side reaches them.
- File > Publish to players writes the client files an Install of the whole project would write into the server's
clientfolder and updates their lines inmanifest.txt. Everything else in that folder and its manifest is left as it was. Each file it replaces is backed up in the project'spublishedfolder. - Players get the new files the next time they start the launcher. Nobody has to restart anything for that.
Publish needs a linked server whose client folder already has a manifest.txt: the folder beside the server folder for Gate to Heavens, and the client folder in the install for RF Online and DragonSoul. If there is none yet, set the updater up once as The launcher describes. Publish is refused while something would stop the Install.
A file the project removes leaves the download, but launchers never delete files, so players who already have it keep it. World of Kung Fu has no launcher yet, so Publish is not offered for it.
Saving
Save (Ctrl + S) saves the open map into the project. Imports, map builds and bakes are kept in the project as soon as they finish, so closing Studio before you install never loses one. Closing a map, opening another, closing the client and restarting to update all save the open map first.