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. 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.

Export project

To export your Arcweave project:

  1. Click on the export icon at the top of the workspace.
  2. Select the tab that is relevant to the desired format (see following sections).
  3. Click the Export button.

JSON

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

Arcweave JSON files can be imported into a Pro or Team workspace. See Import projects on the Projects page under Workspaces, in this documentation.

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

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

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.

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. This produces a .zip file containing:

  • 📝 The story data .json file
  • 📦 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)

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).

When you import an Arcweave JSON file back into Arcweave, items are restored to their original positions on each board.

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

Spreadsheet

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

CSV

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

FilenameColumns
Attributes.csvId, Component Id, Name, Data, Type, RichText, Element Id
Boards.csvId, Parent Id, Has Children, Name
Branches.csvId, Board Id, Theme, Conditions
Components.csvId, Parent Id, Has Children, Attributes, Name - {languageIsoCode}, Status - {languageIsoCode}
Conditions.csvId, Branch Id, Script, Output, Type
Connections.csvId, Board Id, Source Id, Source Type, Target Id, Target Type, Label - {languageIsoCode}, Status - {languageIsoCode}
Elements.csvId, Board Id, Theme, Components, Outputs, Attributes, Title - {languageIsoCode}, Content - {languageIsoCode}, Status - {languageIsoCode}
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.

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, Component Id, Name, Data, Type, RichText, Element Id
BoardsId, Parent Id, Has Children, Name
BranchesId, Board Id, Theme, Conditions
ComponentsId, Parent Id, Has Children, Attributes, Name - {languageIsoCode}, Status - {languageIsoCode}
ConditionsId, Branch Id, Script, Output, Type
ConnectionsId, Board Id, Source Id, Source Type, Target Id, Target Type, Label - {languageIsoCode}, Status - {languageIsoCode}
ElementsId, Board Id, Theme, Components, Outputs, Attributes, Title - {languageIsoCode}, Content - {languageIsoCode}, Status - {languageIsoCode}
JumpersId, Board Id, Element Id
NotesId, Board Id, Content, Theme
VariablesId, Name, Type, Value

ℹ️ In the XLSX export format, text content gets 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 spreadsheet.

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.

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, UI details, and transparency.

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 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 image includes story data only in the current language.
    • Select language: Choose the language to be included in the image from the dropdown.

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

To download the project's assets along with its story data (JSON file) for a game engine, select Include assets. This produces a .zip file that varies according to the chosen game engine. (See Integrations for details.)

Markdown

In Pro and Team workspaces, you can export your story data as a markdown document. This facilitates proof-reading, 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.

Preferences

Boards and elements form the core content of the Markdown document and are included under the ## Boards & Elements heading. In addition, you can enable the following optional sections and features:

  • 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.
  • Variables
    Adds a ## Variables section listing all 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 exported as Markdown

## 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 |

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. Select a language from the dropdown.

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

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.