EnVRonment-Editor

Editor of EnVRonment

Explore the documentation »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Uses
2. Getting Started
   • Prerequisites
   • Installation
3. Documentation
4. Setup
   • Migrations and seeding
5. Usage
   • Running
   • REPL
6. Contributing
7. License
8. Authors

About The Project

This project is the Editor of EnVRonment. It's written in rust and svelte.
The project is split into two parts:

• scene-editor: The editor in bevy.
• visual-editor: The visual scripting part of the editor made with Tauri x Svelte Kit.

(back to top)

Uses

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

You will need to install some tools to run the project.

• You will need to install git to clone the project.
• You will need to install rust nightly (rustup install nightly).
• You will need to install sccache (fast scoop install sccache or slow cargo install sccache).

Installation

Just clone the project and install the dependencies.

git clone git@github.com:StreetLess/Editor
cd Editor
pnpm install:all

(back to top)

Usage

Running

You can run the project with the following commands.

# all (will build and launch in parallel both the scene editor and the visual editor)
pnpm dev

# visual editor
pnpm dev:visual

# scene editor
pnpm dev:scene

Running & Watching for changes

You can run the project with the following commands. Requires cargo-watch (cargo install cargo-watch).

# all (will build and launch in parallel both the scene editor and the visual editor)
pnpm watch

# visual editor
pnpm watch:visual

# scene editor
pnpm watch:scene

Building (debug build)

You can build the project with the following commands.

# all (will build in parallel both the scene editor and the visual editor)
pnpm build

# visual editor
pnpm build-dev:visual

# scene editor
pnpm build-dev:scene

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Read the contributing guide to learn how to contribute to the project.

(back to top)

License

Distributed under the License. See LICENSE for more information.

(back to top)

Authors

Alwyn Mattapullut

Nicolas Réboulé

Alexis Cheron

Hugo Baret