Storing Projects

Nick Pope edited this page Feb 19, 2017 · 9 revisions

Note: This page refers to version 1 of JS-Eden. Version 2 has a simplified save/load mechanism. Documentation for version 2 can be found within the environment.

As of version v1.1.0 it is possible to log in and save your scripts either as your own private model or to share with other users. This page is a quick introduction to saving and loading your work on our servers, which requires you to log in with either a Google Mail account or a Twitter account.

Logging In

When you go to a JS-Eden site, if it has a back-end project storage server, you will see a Login option in the top right corner:

Clicking this will present you with the two login options:

These open a new tab or window in which you have to authorise us to have access to your credentials. We only get access to your name and address (it tells you what we get). Clicking on "Allow" or an equivalent button takes you back to a very simple welcome screen. You can now close that tab and go back to JS-Eden which should show your name in the top right corner.

Browsing Projects

In a script view window you can open up a script browser to see what is available on the project server. The interface is a bit limited at present. To do this, use the menu to the bottom right in the script view:

Clicking browse agents will bring up a dialog:

Here you can explore a hierarchy of scripts. Those in bold are ones that are already loaded into your browser somewhere. Those that are checked are already open in your script view as a tab, and you can check more of them before clicking "Add" to open those as well.

Usually, a particular project has a main script which brings in all the others and sets things up, along with a collection of sub scripts that can be seen by clicking on the little expand triangle. To load a project, usually bring in the main script by checking it.

Uploading a Script

If you are logged in, you can make changes to any existing script and upload a new version of it. Similarly, you can create new scripts using the agent add button in the tab bar and upload those as a new project or part of a new project. To upload a script, right click on its tab to get:

And click "Upload" to get this dialog:

You do not have to enter a name for your version, but it makes it easier to refer to later if you do. Other people can then request to load specific versions of your script using a name instead of some automatically generated version number. You can upload multiple times with the same version name, the newest version with that name is the one that will be brought in automatically.

By default your script versions are private, so check the box if you want to allow others to see your script.

Then click "Upload".

Viewing Versions

A particular script may have many versions by many people and you can browse through all of these different versions and load a specific one. It is also possible to view all of your own auto-saves for changes you have made but not uploaded, these are shown in the same place:

The "View History" option in the bottom right menu of the script view will list all versions available, including all your private versions, any official versions and any public versions made by other people:

For each version you may have a local undo/redo auto save history, this is stored in your browser and not on the server. To load a version, select it and click "Load".

Loading Versions with Import

The usual import command in a script will load the latest official version, or if there is no official version it will load the latest public version. To load a specific named version of a script, use the @ tag:

import my/agent/name@version1;

There are some special tags, namely @latest which will ignore official versions and bring in the most recent version. Generally, don't rely on this and use a specific version instead. Some other special tags are:

  • @default - Same as no tag.
  • @origin - The first version, before first upload.
  • @latest - Most recent version, but can include your own private ones so is not consistent across all users.
  • @OFFICIAL - The most recent official version. Same as @default except it will fail if there are no official versions.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.