Wick Editor

The Wick Editor is a free and open-source tool for creating games, animations, and everything in-between. It's designed to be the most accessible tool for creating multimedia projects on the web.

Getting started

These instructions are for MacOS and Linux, we currently don't have instructions for Windows, but if you need help please feel free to email contact@wickeditor.com.

Requirements

You'll need to download the following:

Installation

1) Clone this repository:

```bash
git clone https://github.com/Wicklets/wick-editor/
```

2) Using the command line, change directories into the newly created wick-editor folder:

```bash
cd wick-editor
```

3) Install all dependencies using this command:

```bash
npm install
```

Running the Editor

1) Run the editor with this command:

```bash
npm start
```

2) Open a web browser and go to this URL:

```bash
localhost:3000
```

Have fun hacking on Wick! 🎉

Deploying to Production

To deploy, you'll need to have push access to this repo.

1) Test the production build by using npm predeploy

2) Run npm run deploy

Deploying to Prerelease

1) Run npm run prerelease-deploy

Support

License

Wick Editor is under the GNU v3 Public License. See the LICENSE for more information.

Building and Releasing the Desktop App

Please refer to this Wiki entry for information on our dektop build processes! https://github.com/Wicklets/wick-editor/wiki/Building-Desktop-Editors-for-Release.

If you are familiar with electron-builder, electron-packager, or have experience building desktop electron apps for production, we could use your help! Please message us or open an issue.