Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .idea/[NanoForge] Editor.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 50 additions & 0 deletions docs/docs/editor/components.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: 'Components'
icon: 'book'
description: 'Nanoforge Editor components'
---

Components define the data and properties of an entity. On their own, they do not contain any logic. Instead, systems use them to determine how entities behave during the game.

## Navigate

To access your components, navigate to the **Components** tabs in the left panel.

![Components navigation](../components-navigate.png)

## Create a component

In the **Components** panel, click **+** and **Create**. Enter a name for your component, and click **Confirm**.

![Create component](../system-create.png) ![Create component name](../components-create-name.png)

## Import a component

In this **Components** panel, click **+** and **Import**.

![Import component](../images/component-import.png)

Choose the components that you need, click **Install** in the top right corner, and click **Apply** when you install all components you want.

![Import components selection](../images/components-import-selection.png)

## Edit a component

To edit a component, navigate to **Components** tab, right-click the component, and click **Open code**. The component source file opens in the code editor.
![Access component code](../components-access.png)

## Add Component to an entity

Navigate to **Scenes** tab, and **Entities** subtab. Choose an entity and the component panel will be display on the right panel.

![Components entity selection](../images/components-entity.png) ![Components entity panel](../images/components-entity-panel)

You can click **Add component** and select the component that you need.

![Add component to a entity](../components-entity-add.png)

## Change entity components data

You can modify the data of a component attach to an entity in the components inspector in the right panel.

![Change component data](../images/components-data.png)
19 changes: 19 additions & 0 deletions docs/docs/editor/entities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: 'Entities'
icon: 'book'
description: 'Nanoforge Editor entities'
---

Entities are the basic objects of your game. They represent all the elements such as player, background, props, or any object.

## Create entity

To access entities, navigate to **Scenes** tab, and **Entities** subtab. Click to **New entity**. You can organize your entities in folder.

![New entity](../images/entities-new.png)

## Delete or Rename entity

To modify an entity, right-click on it and select **Edit**. Enter the new name and confirm the change. You can also select **Delete** to remove the entity.

![Rename entity](../images/entities-rename.png)
15 changes: 15 additions & 0 deletions docs/docs/editor/export.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Export'
icon: 'book'
description: 'Nanoforge Editor export'
---

You can export your project to keep a local copy of your game.
Open the **File** menu and click **Export**.

![Export button](../images/export.png)

Wait a few seconds for the archive to be generated, then click **Download archive**.
The download link remains available for 15 minutes.

![Download archive button](../images/download-export.png)
48 changes: 48 additions & 0 deletions docs/docs/editor/systems.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: 'Systems'
icon: 'book'
description: 'Nanoforge Editor systems'
---

Systems contain the logic of your game. They are executed while the game is running and define the behavior of your entities.

## Navigate

To access your systems, navigate to the **Systems** tabs in the left panel.

![System navigation](../systems-navigate.png)

## Create a system

In the **Systems** panel, click **+** and **Create**. Enter a name for your system, and click **Confirm**.

![Create system](../system-create.png) ![Create system name](../system-create-name.png)

## Import a system

In this **Systems** panel, click **+** and **Import**.

![Import system](../images/system-import.png)

A list of system appear, you can now choose a system, click **Install** in the top right corner, and click **Apply** when you install all systems you want.

![Import system selection](../images/system-import-selection.png)

## Add system to the scene

There are two ways to add a system to a scene.

### 1. Add to the active scene

In the **Systems** tab, right-click on the system you want and select **Add to active scene**
![Add system to active scene](../images/system-add-to-scene-1.png)

### 2. Pick a system on your scene

Navigate to **Scenes** tab, and select the **System** subtab. Click **+**, choose a system from the list, and click **Confirm**.
![Add system to a scene](../images/system-add-to-scene-2.png)

## Edit a system

To edit a system, navigate to **Systems** tab, right-click the system you want edit, and click **Open code**. The system source file opens in the code editor.
![Access system code](../system-access.png)
21 changes: 21 additions & 0 deletions docs/docs/editor/viewport.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: 'Viewport'
icon: 'book'
description: 'Nanoforge Editor viewport'
---

# The Viewport

The viewport is a preview of your game, where you can run it and interact while editing.

## Edit mode

![Viewport toolbar on edit mode](../images/viewport-panel-edit.png)

When the game is not running, the viewport toolbar displays two available buttons: Click **Play** (left) to start the game in the viewport and **Reload** (right) to restart the game with the last changes.

## Play mode

![Viewport toolbar on play mode](../images/viewport-panel-play.png)

When the game is running, the toolbar displays three buttons. Click **Pause** (left) to pause or resume the game, **Stop** (middle) to stop the game and **Reload** (right) to restart the game with the last changes.
24 changes: 24 additions & 0 deletions docs/docs/getting-started/create-your-first-project.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 'Create your first project'
icon: 'book'
description: 'How to create your first project'
---

To create your first game, start by creating a project from the [Project Dashboard](https://projects.nanoforge.eu/dashboard/projects). Click **New project** and fill the project information.

![Create Project](../images/create-project.png)

If you want to automatically link your project to a github repository, click **Add repositories from github** and select the organization you want to use.

Once your project has been created, click **Open Editor** to launch it in the Nanoforge Editor. This will open the project initialization page, where you choose your programming language and select either a single-player or multiplayer game.

![Init Project](../images/init-project.png)

After the project is initialized, you will be redirected to the editor, which is composed of several panels:

- **Center**: The **Viewport**, where you can preview and interact with your game while editing.
- **Left**: The **Project Explorer**, where you can manage your scenes, entities, and systems. You can also switch between the Components, Systems, Assets, and Libraries tabs.
- **Right**: The **Inspector**, which displays the properties of the selected entity and lets you add, remove, or edit its components.
- **Bottom**: The **File Explorer**, where you can browse your project files and open them to start coding.

![Main Editor](../images/main-editor.png)
19 changes: 19 additions & 0 deletions docs/docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: 'Editor'
icon: 'book'
description: 'Nanoforge Editor documentation'
---

Nanoforge editor provide a complete online editor for create your game.

## Start Here

- [Create your first project](create-your-first-project)

## Editor Documentation

- [Entities](../editor/entities)
- [Components](../editor/compoents)
- [Systems](../editor/systems)
- [Viewport](../editor/viewport)
- [Export](../editor/export)
Binary file added docs/docs/images/components-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-create-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-entity-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-entity-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-entity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/components-navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/download-export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/entities-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/entities-rename.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/init-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/main-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-add-to-scene-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-add-to-scene-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-create-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-import-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/system-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/systems-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/systems-navigate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/viewport-panel-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/viewport-panel-play.png
Loading