Skip to content

StickmanRed/wick-editor

 
 

Repository files navigation


Wick Editor

follow on Twitter

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 contact upstream!

Requirements

You'll need to download the following:

  • NodeJS 14 (NOTE: This is a ancient version of NodeJS, from the ancient times)
  • NodeJS 14 from scoop (Great package manager for people who don't wanna install stuff using wonky installers)

Installation

  1. Clone this repository:

    git clone https://github.com/StickmanRed/wick-editor.git
  2. Using the command line, change directories into the newly created wick-editor folder:

    cd wick-editor
  3. Install all dependencies using this command:

    npm install

Running the Editor

  1. Run the editor with this command:

    npm start
  2. Open a web browser and go to this URL:

    localhost:3000

    (NOTE: It may open up itself once npm start is ran).

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.

Links

Building and Releasing the Desktop App

Please refer to this Wiki entry for information on our desktop build processes! https://github.com/Wicklets/wick-editor/wiki/Building-Desktop-Editors-for-Release. (NOTE: We don't actually build these, old electron is a finicky mess).

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.

Contributors

About

A free and open-source tool for creating games, animations and everything in-between!

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 92.9%
  • HTML 6.5%
  • Other 0.6%