Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 13.5 KB

files.md

File metadata and controls

87 lines (66 loc) · 13.5 KB

Files and command line

This chapter describes the files ALIEN works with, how simulations are saved automatically, how to share your work through the browser and how to run simulations without a window.

File types

File Contents
.sim A complete simulation: all objects, energy particles, creatures and genomes, the simulation parameters, the statistics history, the time step and the position of the view.
.genome A single genome, as created in the genome editor.
.settings.json A set of simulation parameters including layers and radiation sources. It can be loaded into any simulation.
.png A picture created with Simulation > Save picture. Tools > Image converter (Alt+Y) turns a PNG image into a pattern of solid objects.
.mp4 A video recorded with Tools > Recorder.
.flight.json The waypoints and settings of a camera flight, as created in Tools > Recorder.

Opening and saving

The browser (Alt+B) shows the simulations of this computer next to those of the ALIEN server. Its left column lists the workspaces. My simulations and Autosaves are on this computer, while Featured, Community and My uploads are on the server. Liked collects the entries of the server you reacted to. On the Genomes tab, My genomes takes the place of My simulations, and there are no autosaves.

  • Saving. Simulation > Save (Ctrl+S) opens the Save simulation dialog. It shows a picture of the current view and asks for a name and an optional description. Save to chooses the target. My simulations stores the simulation on this computer. Community and My uploads upload it to the server, see Sharing in the browser. My simulations is preselected at first. After a save with another target, the dialog starts with that target the next time.
  • Names and folders. A slash in the name creates folders, for example My worlds/Ocean. A simulation that was opened from My simulations or saved there before keeps its name as the suggestion. While the browser shows simulations, Ctrl+S and Save in its tool bar suggest the name of the selected entry instead, also of an autosave, or the folder of a selected folder. If the name is already in use at the target, the button reads Replace and the dialog tells what is replaced.
  • Opening. In the browser, click a simulation of My simulations to see its picture, its description and its data in the right column. Double-click it or choose Open there to load it. The right column also renames, shares, replaces and deletes the selected simulation. Replace stores the current simulation in its place and keeps its name and its description.
  • Other locations. Simulation > Open (Ctrl+O) and Open simulation in the tool bar of the browser load a simulation file from any folder. Other location under Save to in the Save simulation dialog saves the simulation as a file in any folder.
  • Where the files are. The simulations of this computer are ordinary .sim files in one folder, by default simulations in the ALIEN folder. The folders of the browser are its subfolders. The picture of a simulation is a JPG file and its description a text file of the same name next to it. The row above the entries of My simulations shows this folder as Folder. The two buttons next to it choose another folder and open it in the file manager. Simulation files copied into the folder appear in the browser. A simulation without a picture gets one when it is opened.
  • Simulation > New (Ctrl+N) creates an empty world.
  • Save genome in the tool bar of the genome editor or of the browser opens the Save genome dialog for the genome of the genome editor. It works like the Save simulation dialog, and My genomes stores the genome on this computer with a picture and a description. A double-click on a genome in My genomes opens it in the genome editor, and Replace there stores the genome of the genome editor in its place. Open genome loads a genome file from any folder. The genome files lie in the same folder as the simulations.
  • Parameter sets are opened and saved in the tool bar of the Simulation parameters window.
  • Camera flights are opened and saved in the tool bar of the Recorder window.
  • If Settings > Save on exit is enabled, which is the default, ALIEN saves the current simulation to resources/autosave/autosave.sim in the ALIEN folder when it closes. ALIEN opens this file at every start until you delete it, even after Save on exit has been disabled.

Autosave

Autosave protects long runs. It saves the current simulation at regular intervals into the Autosaves workspace in the left column of the browser. Autosave is switched off when ALIEN starts and whenever a simulation is created or opened. Activate autosave in the row above the autosaves opens a dialog with the settings and switches it on. While autosave is on, a dot marks Autosaves in the left column and the row shows the interval and the time until the next autosave. Deactivate autosave switches it off. To change the settings, deactivate autosave and activate it again.

  • Folder is at first the folder of My simulations. Choosing another folder here or in My simulations changes only that one of the two. The folder of the autosaves can only be changed while autosave is off.
  • Interval (min) sets the time between two autosaves, 40 minutes by default. The interval counts minutes of real time, so autosaves are also created while the simulation is paused.
  • Subfolder names the folder inside Folder in which new autosaves are stored, for example one subfolder for each simulation run. A slash or a backslash creates nested subfolders. The autosaves that already exist stay where they are.
  • Mode is Limited save files by default. In this mode, Number of files limits how many autosaves are kept in a folder, 20 by default. Each new autosave deletes the oldest ones of its folder beyond this number. In Unlimited save files mode, all autosaves are kept.
  • Autosave now next to Activate autosave creates an autosave right away, whether autosave is on or off.
  • The file name of an autosave is save_ followed by its time step. Autosaves that lie in the folder of My simulations are also listed there like any other simulation. In Autosaves, the right column offers the same actions for the selected autosave as My simulations. To keep an autosave for good, give it a name of its own with Edit, which moves it to My simulations. A simulation saved under the name of an autosave replaces it and still counts as an autosave.
  • Earlier versions. At the first start of this version, the folder in which the Autosave window of an earlier version has created save points becomes the folder of the simulations of this computer. These save points appear in Autosaves and in My simulations. They count as autosaves, so in Limited save files mode the oldest ones of the current subfolder are deleted as well. Save points that an earlier version has stored directly in the resources folder are loaded with Open simulation in the tool bar of the browser.

Sharing in the browser

The browser (Alt+B) connects ALIEN with the ALIEN server, where users share simulations and genomes.

  • Browsing works without an account. The Featured workspace contains simulations of the ALIEN project, and the Community workspace contains everything users have shared.
  • Logging in. Choose Network > Login (Alt+L) or click the account chip in the browser. The login dialog also lets you create a new account. With an account you can upload your own work, which My uploads lists.
  • Uploading. Choose Community or My uploads as the target in the Save simulation dialog (Ctrl+S). Alt+D opens the dialog with Community preselected, and Alt+Q does the same for the genome of the genome editor. With a target on the server, the name is prefilled with your user name as a folder, followed by the project name of the simulation or the name of the genome, for example UserName/Ocean. A slash in the name creates folders, for example My worlds/Ocean. You can add a description.
  • Sharing a saved simulation. Share in the right column of My simulations uploads the selected simulation with its picture and its description. The name is prefilled with your user name as a folder, followed by the name of the simulation, for example UserName/Ocean. A simulation that carries the name of one of your uploads, with or without this folder, shows where it has been uploaded and how many reactions it has received.
  • Replacing an upload. Replace in the right column of one of your uploads replaces its content and its picture with the current simulation, or with the genome of the genome editor on the Genomes tab. Its name, its description and its reactions are kept.
  • Visibility. Community makes the upload visible to everyone in the Community workspace and also posts it on the ALIEN Discord server. My uploads keeps it visible only to you. Every upload of yours is listed in My uploads, where the right column switches its visibility between Community and Only me. After the upload, Show in browser selects the new entry in the browser.
  • Managing. Select one of your uploads to rename it, to change its description, to switch it between private and community or to delete it in the right column. To replace an upload with a newer version, save the current simulation under the same name with the same target.
  • Storage. Your uploads may occupy up to 1 GB on the server. While nothing is selected, the right column of My uploads on the Simulations tab shows how much of it is used and how much is still free. An upload or a replacement that would exceed this limit is refused. The other workspaces of the Simulations tab show the total size of their entries there.
  • Reacting. No account is needed. Click the heart on the picture of an entry to give it a heart and click it again to take it back. A right click chooses another reaction, and the right column shows all reactions to the selected entry. Liked in the left column collects all entries you reacted to. The gallery view can sort by reactions, date or downloads.
  • Credits. While a simulation from the server is open, the right end of the menu bar shows its name, its author and a heart. Click the name to show the entry in the browser or the heart to give it a heart. A simulation from My simulations or Autosaves shows only its name there.

Command line interface

ALIEN includes a second program, alien-cli (on Windows alien-cli.exe for NVIDIA and alien-cli-amd.exe for AMD), which runs a simulation without any window. It is useful for long experiments, for automation and on computers without a monitor, such as rented cloud servers with a GPU.

alien-cli -i input.sim -o output.sim -t 100000
Option Meaning
-i The simulation file to run.
-o The file to which the result is written.
-t The number of time steps to calculate. Without it, the simulation runs until you press Q or Ctrl+C. Both stop the run and write the output file.
-u, -p User name and password for the ALIEN server. The long forms are --user and --password.
--upload-name The base name for periodic uploads of the running simulation to My uploads, visible only to you. Each upload gets this name followed by an underscore and a consecutive number, for example Run_1 and Run_2. Requires --upload-interval and a login with -u and -p.
--upload-interval The number of minutes between two uploads. The first upload takes place one interval after the start. Requires --upload-name.
-d Debug mode, which runs slower but writes detailed timing and trace files. The long form is --debug.
--plain Plain text output without colors or a status panel.
--no-count-as-active Do not count this run as an active simulator (see below).
-h Show all options and exit. The long form is --help.

Like the graphical program, alien-cli is included in the number of active simulators that the Browser window shows, even without a login. While it runs, it reports to the ALIEN server every 5 minutes, the first time 5 minutes after its start. Each instance stays counted for 25 minutes after its last report. Instances that share one IP address count once. To leave a run out, start it with --no-count-as-active or disable Count me as active in Settings > Network settings of the graphical program. Both programs share this setting if they run on the same computer under the same operating system user, regardless of the ALIEN account.

A Docker image with the command line interface is published as chrxh/alien:nightly. See the README of the project for details.

The Console mode of the graphical program (Alt+C) is similar to alien-cli. It hides the user interface and switches off the rendering until you press Esc. See The user interface.

Log files

ALIEN writes its messages to log.txt in the ALIEN folder and replaces this file at every start. The Log window (Alt+6) shows the same messages. If ALIEN crashes, enable Settings > Debug mode, reproduce the problem and copy log.txt and trace.txt from the ALIEN folder before you start ALIEN again. Attach the copies to a bug report. If ALIEN crashes before you can use the menu, start it from the command line with the option -d, which switches on debug mode from the beginning. See Troubleshooting for details.