Skip to content

Export your project ​

Arcweave supports exporting your project data to the following formats:

✅ The JSON and Game engine JSON exports provide the option to also export the project's assets. This option is selected by default. See each format below for details.

✅ If your project has multiple languages (see Localization), you have the option to select which translations are to be included in the export. See each export format below for details. Language options appear only in workspaces that support Localization (Team); other workspaces export the main language.

Export project ​

To export your Arcweave project:

  1. Open the project.
  2. Click the Export project button in the project's top menu.
  3. Select the tab that is relevant to the desired format (see following sections).
  4. Click Export.

Exporting requires the Export projects permission, which owners and editors have by default. Exporting a project backup also requires the Export projects backup permission; see Roles. Arcweave remembers each project's export options for the next export.

Export as JSON ​

Exporting as JSON produces a .json file containing all the project's story data.

✅ Arcweave JSON files can be imported into a workspace (Basic, Pro, and Team). See Import projects.

You can study the schema of Arcweave's JSON under the Integrations section.

ℹ️ In the JSON format, text content is exported in html encoding.

Export specific boards ​

By default, Arcweave exports all boards of your project.

To export specific boards:

  1. Go to the section titled Boards to export.
  2. Choose Select boards instead of All boards.
  3. Select the boards you want to be included in the JSON file.

Board selection filters boards and their board items. Components, attributes, assets, and global variables are still exported for the whole project, including attributes belonging to excluded boards or items. Review these collections before sharing a partial export.

Export languages ​

If your project has multiple languages (see Localization), you can select which translations are to be included in the export:

  1. Go to the section titled Languages to export.
  2. Switch among the following:
    • Current language: The JSON includes story data only in the current language.
    • All languages: The JSON includes story data in all languages.
    • Select language: Choose the language to be included in the JSON from the dropdown.

Include assets ​

To download the project's assets along with its story data (JSON file), select Include assets (selected by default). This produces a .zip file containing:

  • 📝 The story data .json file (project_settings.json)
  • 📦 An assets folder containing the project's assets, with their subfolder structure matching that of the project
  • 🖼️ A cover folder containing the project's cover (if any)

The archive includes the entire project's assets, even when you select specific boards. Assets are included whether or not the selected boards use them.

Include coordinates ​

To export the spatial layout of your boards, select Include coordinates. This option stores the following extra properties:

  • x and y position coordinates of all board items (elements, notes, jumpers, and branches).
  • width, height, and autoHeight of resizable board items (elements and notes).

With Include coordinates enabled, importing the JSON file restores items to their original positions on each board. Without it, importing generates a new layout and uses default element/note dimensions. The REST JSON export always omits this layout data and has no Include coordinates option.

ℹ️ The autoHeight property is a boolean indicating whether the element or note automatically adjusts its height to the size of its content.

Export as spreadsheet ​

Arcweave offers the option to export your project as a spreadsheet, in CSV or XLSX (Excel format).

✅ XLSX spreadsheets can be imported for translating purposes into any project of a Team workspace, using the Localization menu.

The column tables below show the single-language layout used by Current language and Select language, without language suffixes or translation-status columns. For All languages, see All-languages columns.

CSV ​

Exporting in Comma Separated Values (CSV) produces a .zip file containing the following files:

FilenameColumns
Attributes.csvId, Custom Id, Component Id, Board Id, Name, Data, Type, RichText, Element Id
Boards.csvId, Custom Id, Parent Id, Has Children, Name
Branches.csvId, Board Id, Theme, Conditions
Components.csvId, Custom Id, Parent Id, Has Children, Name, Attributes
Conditions.csvId, Branch Id, Script, Output, Type
Connections.csvId, Board Id, Source Id, Source Type, Target Id, Target Type, Label
Elements.csvId, Board Id, Title, Content, Theme, Components, Outputs, Attributes
Jumpers.csvId, Board Id, Element Id
Notes.csvId, Board Id, Content, Theme
Variables.csvId, Name, Type, Value

ℹ️ In the CSV export format, text content is exported in html encoding.

ℹ️ Variables.csv contains global variables. Board and component variables appear in Attributes.csv: Custom Id provides the variable name, while Board Id or Component Id links it to its owner. The owner's Custom Id in Boards.csv or Components.csv provides the Arcscript scope.

XLSX ​

Pro and Team workspaces allow exporting your project data for Excel, producing a .xlsx file that contains a separate sheet for each item:

SheetColumns
AttributesId, Custom Id, Component Id, Board Id, Name, Data, Type, RichText, Element Id, Arcweave Link
BoardsId, Custom Id, Parent Id, Has Children, Name
BranchesId, Board Id, Theme, Conditions, Arcweave Link
ComponentsId, Custom Id, Parent Id, Has Children, Name, Attributes, Arcweave Link
ConditionsId, Branch Id, Script, Output, Type, Arcweave Link
ConnectionsId, Board Id, Source Id, Source Type, Target Id, Target Type, Label, Arcweave Link
ElementsId, Board Id, Title, Content, Theme, Components, Outputs, Attributes, Arcweave Link
JumpersId, Board Id, Element Id, Arcweave Link
NotesId, Board Id, Content, Theme, Arcweave Link
VariablesId, Name, Type, Value, Arcweave Link
Languages (All languages only)Name, ISO, Base Language

ℹ️ In the XLSX export format, text content gets exported in html encoding.

ℹ️ The Variables sheet contains global variables. Board and component variables appear in the Attributes sheet: Custom Id provides the variable name, while Board Id or Component Id links it to its owner. The owner's Custom Id in the Boards or Components sheet provides the Arcscript scope.

✅ XLSX spreadsheets can be imported for translating purposes into any project of a Team workspace, using the Localization menu.

ℹ️ The Languages sheet is included when you export All languages. This is the format required when preparing an XLSX file for localized spreadsheet import.

All-languages columns ​

With All languages, the following sheets and their CSV counterparts use these columns instead. {languageIsoCode} is the language's ISO code, such as en or fr. Text columns include every language; Status columns include only translations, never the main language.

Sheet / CSV fileFirst columns, in orderFollowing language columns, in order
Components / Components.csvId, Custom Id, Parent Id, Has Children, AttributesFor each language: Name - {languageIsoCode}, followed by Status - {languageIsoCode} if it is a translation.
Connections / Connections.csvId, Board Id, Source Id, Source Type, Target Id, Target TypeFor each language: Label - {languageIsoCode}, followed by Status - {languageIsoCode} if it is a translation.
Elements / Elements.csvId, Board Id, Theme, Components, Outputs, AttributesAll Title - {languageIsoCode} columns, then all Content - {languageIsoCode} columns, then all Status - {languageIsoCode} columns for translations.

Languages follow the project's language order within each group. XLSX appends one Arcweave Link column after these language columns and includes the Languages sheet. CSV includes neither Arcweave Link columns nor a Languages.csv file. Other sheets and files keep the columns listed above.

Open items from an XLSX export ​

Click Open in Arcweave in a row's Arcweave Link column to open that item in its original project. The recipient needs access to the project's boards.

SheetWhere the link opens
Elements, Jumpers, Branches, NotesThe item on its board
ConnectionsThe connection's area on its board
ConditionsThe branch containing the condition
ComponentsThe component's dialog
AttributesThe owning element, component dialog, or board variables dialog
VariablesThe global variables dialog

Component folder rows have no link. Each eligible sheet has one Arcweave Link column, regardless of the number of exported languages.

The language selected when exporting determines how the link opens:

  • Current language or Select language: the link selects the exported language. A translation opens in Translation Mode; the main language opens outside Translation Mode.
  • All languages: the link does not select a language. Choose the language in Arcweave's Localization menu. A project opened fresh starts in its main language; navigation within an already open project keeps the current language.

If the linked translation is no longer available, or the workspace does not support localization, the link opens the item without changing the current language.

Board item links move directly to the target. Arcweave saves the resulting position and zoom, so refreshing or reopening the board returns to that view. You can also use Copy link in the editor for supported items. See Share an item or board position for menu locations and the difference between an item link and the resulting browser URL.

Exported boards ​

Spreadsheet exports include all boards in the project.

Export languages ​

If your project has multiple languages (see Localization), you can select which translations are to be included in the export:

  1. Go to the section titled Languages to export.
  2. Switch among the following:
    • Current language: The spreadsheet includes story data only in the current language.
    • All languages: The spreadsheet includes story data in all languages.
    • Select language: Choose the language to be included in the spreadsheet from the dropdown.

Export as image file ​

You can export the current board as an image. This supports the following specifications:

JPG ​

The .jpg format uses lossy compression and is best for lightweight exports and sharing, where smaller file size is preferred over maximum image fidelity.

PNG ​

The .png format is a lossless bitmap image and is best for high-quality exports, preserving sharp text and UI details. The board background is included, so the image is not transparent.

Image size ​

The available options for exported image size are:

  • Small: 1600 x 900
  • Medium: 3200 x 1800
  • Large: 6400 x 3600 (Pro and Team workspaces only)

Checking the Print-friendly checkbox converts the picture to a light mode style, making it more suitable for printing.

Export specific boards ​

Currently, you can only export the current board as an image.

Export languages ​

If your project has multiple languages (see Localization), you can select which language is to be included in the export:

  1. Go to the section titled Language to export.
  2. Switch among the following:
    • Current language: The image includes story data only in the current language.
    • Select language: Choose the language to be included in the image from the dropdown.

Export for game engines ​

You can export your project data for direct import in other platforms; see the Integrations section of this documentation.

Export language ​

If your project has multiple languages (see Localization), you can select which language is to be included in the export for the game engine:

  1. Go to the section titled Language to export.
  2. Select a language from the dropdown.

Include assets ​

Game engine exports are .zip files named after the chosen engine. The archive contains the story data as project.json. To also include the project's assets, select Include assets (selected by default): the archive then adds an assets folder and a cover folder, as in the JSON export. See Integrations for how to import the archive.

Export as Markdown ​

In Pro and Team workspaces, you can export your story data as a Markdown document. This facilitates proofreading, sharing dialogue with voice actors, etc.

Export specific boards ​

By default, Arcweave exports all boards and elements of your project.

To export only specific boards and their elements:

  1. Go to the section titled Boards to export.
  2. Choose Select boards instead of All boards.
  3. Select the boards you want to be included in the Markdown document.

Board selection filters boards and their elements. The Components and Variables sections still list the whole project's components and global variables.

The Markdown document uses the project's main language; this export has no language option.

Preferences ​

Boards and elements form the core content of the Markdown document and are included under the ## Boards & Elements heading. Board attributes, including board variables, are listed with their boards. In addition, you can enable the following optional sections and features in the Include section. All of them are enabled by default:

  • Table of contents
    Adds a ## Table of Contents section at the beginning of the document, listing all boards and elements, along with any enabled optional sections.
  • Overview
    Adds an ## Overview section that displays the starting element's title and project statistics before the document's main content.
  • Components
    Adds a ## Components section listing all components and their attributes, including component variables.
  • Variables
    Adds a ## Variables section listing all global variables, their types, and initial values.
  • Option text
    Includes the text of each element's outgoing options and branch logic, so the story flow is easy to follow. When combined with Links (see below), the option text becomes clickable, enabling playable navigation when the document is opened in a Markdown viewer.
  • Links
    Creates links for in-project references (boards, elements, components) and URLs. When combined with Option text (see above), links enable clickable option text for playable navigation.
  • Dividers
    Inserts horizontal rules between sections for improved readability and printing.
  • Item prefixes
    Prefixes boards, elements, and components with generated IDs (B1, E1, C1, etc.) and reuses them in links for quick cross-referencing.

Markdown example ​

The following is the Markdown document of the Interactive Fiction Example (The Castle—see Project templates). All of the above preferences have been included during exporting.

Click to expand Arcweave Markdown example
markdown
# The Castle

## Table of Contents

- [Overview](#overview)
- [Boards & Elements](#boards--elements)
  - [B1: Main Board](#b1-main-board)
    - [E1: Outside Castle Monsignor](#e1-outside-castle-monsignor)
    - [E2: Castle Courtyard](#e2-castle-courtyard)
    - [E3: The small house - Overview](#e3-the-small-house---overview)
    - [E4: Examine the painting](#e4-examine-the-painting)
    - [E5: The stone passage](#e5-the-stone-passage)
    - [E6: The Crusader](#e6-the-crusader)
  - Dialogues
    - [B2: Crusader Dialogue](#b2-crusader-dialogue)
      - [E7: Dialogue start](#e7-dialogue-start)
      - [E8: Trying to run past](#e8-trying-to-run-past)
      - [E9: The Question](#e9-the-question)
      - [E10: Correct answer](#e10-correct-answer)
      - [E11: Game over](#e11-game-over)
      - [E12: Wrong answer](#e12-wrong-answer)
      - [E13: Success](#e13-success)
  - [B3: Credits](#b3-credits)
- [Components](#components)
  - Characters
    - [C1: Crusader](#c1-crusader)
  - Locations
    - [C2: Castle Courtyard](#c2-castle-courtyard)
    - [C3: Castle Monsignor](#c3-castle-monsignor)
- [Variables](#variables)
  - `score`

---

## Overview

- **Starting Element:** [E1: Outside Castle Monsignor](#e1-outside-castle-monsignor)
- **Elements:** 13
- **Boards:** 3
- **Components:** 3
- **Variables:** 1

---

## Boards & Elements

### B1: Main Board

#### E1: Outside Castle Monsignor

**⭐ Starting Element**

You have just arrived at [C3: Castle Monsignor](#c3-castle-monsignor), your uncle's home for the past 20 years. The tone of his letter was desperate, urgently asking for your help. Worried, you quickly packed your suitcase and took the first plane.

Faint bird sounds break the eerie silence and a pale mist engulfs the castle hill.

**To the north you can see the castle entrance.**

- [Enter the castle](#e2-castle-courtyard)

---

#### E2: Castle Courtyard

You stand inside a small courtyard. Everything is unusually silent here.

**The path leads further to the north. An abandoned house lies to your left.**

- [Follow the path north](#e5-the-stone-passage)
- [Enter the house](#e3-the-small-house---overview)
- [Exit Castle Monsignor](#e1-outside-castle-monsignor)

---

#### E3: The small house - Overview

The interior looks more like an artist's studio than a house. A few abstract paintings lie scattered around.

One of the paintings depicts a strange figure: a knight dressed in white, with a red cross on his chest.

- [Examine the painting `if visits(examine_the_painting)` one more time `endif`](#e4-examine-the-painting)
- [Back to Castle Courtyard](#e2-castle-courtyard)

---

#### E4: Examine the painting

The knight is guarding a mysterious gate. You see a name written above his head:

> "Conrad IV, Count of Exeter"

```
if visits(the_crusader)
```

He looks just like the crusader you saw guarding the door!

```
endif
```

```
if visits() == 1
```

You make a mental note of the knight's name.

```
score += 2
```

\(Your score just went up 2 points. You now have a score of

```
show(score, ".)")
```

```
endif
```

- [Step back from the painting](#e3-the-small-house---overview)

---

#### E5: The stone passage

A stone passage. The sound of dripping water is echoing in the distance. You feel uneasy.

- [Walk further down the path](#e6-the-crusader)
- [Back to Castle Courtyard](#e2-castle-courtyard)

---

#### E6: The Crusader

[C1: Crusader](#c1-crusader)

You reach a wooden door. In front of you stands a strange man dressed as a medieval crusader.

- [Talk to the man](#e7-dialogue-start)
- [Back to the stone passage](#e5-the-stone-passage)

---

### B3: Credits

### B2: Crusader Dialogue

#### E7: Dialogue start

The man looks at you suspiciously and tightens his sword grip. He speaks in a deep voice: _"What do you want stranger?"_

- [_"Can I pass?"_](#e9-the-question)
- [_"I'll come back later."_](#e5-the-stone-passage)

---

#### E8: Trying to run past

As you try to run past him, he swiftly grabs you by the neck. You fight for freedom but his grip is inhumanly strong.

You drift into unconsciousness...

- [E11: Game over](#e11-game-over)

---

#### E9: The Question

_"Only he who knows my name shall pass,"_ he hisses.

- (Conditional Branch)
  - **IF** `visits(examine_the_painting)` → [_"Conrad IV, Count of Exeter?"_](#e10-correct-answer)
  - **ELSE** → [_"Uh... Crusader?"_](#e12-wrong-answer)
- [Try to run past him](#e8-trying-to-run-past)
- [_"I'll come back later."_](#e5-the-stone-passage)

---

#### E10: Correct answer

At once, you utter the name you remember from the painting. In the blink of an eye, the [C1: Crusader](#c1-crusader) disappears... Almost as if he were never there.

Weird.

```
score += 3
```

\(Your score just went up 3 points. You now have a score of

```
show(score, ".)")
```

- [Open the door](#e13-success)

---

#### E11: Game over

Alas, you did not manage to find what lies behind the ominous door...

---

#### E12: Wrong answer

*"Wrong!"*he shouts. Before you can utter another word he strikes you with the back of his sword hilt.

Everything fades to black...

- [E11: Game over](#e11-game-over)

---

#### E13: Success

Congrats, you finished the example project! 🎉 Now try and make your own interactive experience. If you need help, check the [docs](https://docs.arcweave.com), our [YouTube tutorials](https://youtu.be/Dfm6dKQH3I0), or ping us on [Discord](https://discord.gg/atVXxAK)!

Happy creations! 😊

---

## Components

### C1: Crusader

**Cover:** `crusader.jpeg`

**Attributes:**

| Attribute     | Value                                                                                                                           | Type      |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Real name`   | Conrad IV, Count of Exeter                                                                                                      | rich-text |
| `Defeated by` | Telling him his real name, which can be found on a painting inside the small house                                              | rich-text |
| `Description` | The Crusader exists as an early obstacle to the player, introducing an atmosphere of danger and anachronism throughout the game | rich-text |

---

### C2: Castle Courtyard

**Cover:** `castle`

**Attributes:**

| Attribute     | Value                             | Type      |
| ------------- | --------------------------------- | --------- |
| `Description` | The courtyard of Castle Monsignor | rich-text |

---

### C3: Castle Monsignor

**Cover:** `monsignor.jpeg`

**Attributes:**

| Attribute                | Value                                                                                                                                                                                                                                                                                                                                               | Type           |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `Info`                   | Castle Monsignor is where the game plot and narrative take place. It was built in 1562 near Devonshire, England. The Castle is home to Lord Monsignor, the player's uncle, who has been living there for the past 20 years. The castle has recently become a time traveling portal, allowing people from the 16th century to travel to the present. | rich-text      |
| `Characters living here` | [C1: Crusader](#c1-crusader)                                                                                                                                                                                                                                                                                                                        | component-list |

---

## Variables

| Variable | Initial Value | Type    |
| -------- | ------------- | ------- |
| `score`  | `0`           | integer |

Export as PDF ​

In Pro and Team workspaces, you can export the current board in the Adobe Portable Document Format (PDF). This supports the following specifications:

  • Lossless vector format.
  • All text retains its selectability.

Export specific boards ​

Currently, you can only export the current board as a PDF.

Export language ​

If your project has multiple languages (see Localization), you can select which language is to be included in the PDF export:

  1. Go to the section titled Language to export.
  2. Switch among the following:
    • Current language: The PDF includes story data only in the current language.
    • Select language: Choose the language to be included in the PDF from the dropdown.

Checking the Print-friendly checkbox converts the picture to a light mode style, making it more suitable for printing.

Export project backup ​

Pro and Team workspaces allow exporting the data of their projects to an encrypted Arcweave file format (.arcw).

When exporting a project as an Arcweave file:

  • All project data including notes, comments, assets, and languages are included in the exported file.
  • Editors and commenters are not included in the exported file.
  • Exported .arcw files can be imported into Pro and Team workspaces. See Import projects on the Projects page under Workspaces, in this documentation.

Automate exports ​

In Team workspaces, you can export your projects using the Export endpoints of Arcweave's REST API.