sunrize/README.md

A Multi-Platform X3D Editor

# [Sunrize](https://create3000.github.io/sunrize/) — A Multi-Platform X3D Editor

[![NPM Version](https://img.shields.io/npm/v/sunrize)](https://www.npmjs.com/package/sunrize)
[![NPM Downloads](https://img.shields.io/npm/dm/sunrize)](https://npmtrends.com/sunrize)
[![DeepScan grade](https://deepscan.io/api/teams/23540/projects/26817/branches/855450/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=23540&pid=26817&bid=855450)

## Introduction

Sunrize is based on [X_ITE](https://create3000.github.io/x_ite/) and is a basic editor for X3D files. The scene can be edited in an Outline Editor and there is a Script Editor where Script nodes and ComposedShader nodes can be edited.

## Quick Links

* [Website](https://create3000.github.io/sunrize/)
* [Documentation](https://create3000.github.io/sunrize/documentation/)

## Usage

First you need to install both Node.js and npm on your system. To accomplish this, you can use a [Node installer](https://nodejs.org/en/download/) (Windows), or use [Homebrew](https://brew.sh) to install node (macos), or use your Linux package manager.

Then you can run Sunrize without installing it using npm's **npx** command:

```console
$ npx sunrize@latest [files]
```

>**Note:** The first time, it may take a while for Sunrize to start.

## License

Sunrize is free software and licensed under the [MIT License](LICENSE.md).