|
|
## Installation
|
|
|
|
|
|
To install the Editor, you can either use the pre-build packages,<br/>
|
|
|
or start the tool directly from sources. <br/>
|
|
|
No matter which way you're choosing, the app is always protable and has no external dependencies.
|
|
|
|
|
|
#### Pre-build Packages
|
|
|
|
|
|
The packages can be found at: https://gitlab.com/ice-spear-tools/ice-spear-builds <br/>
|
|
|
Simply download the matching .7z archive adn extract it. <br/>
|
|
|
Inside you will find a "ice-spear-editor.exe" (windows) or "ice-spear-editor" (linux) file.<br/>
|
|
|
Run the file and that's it.
|
|
|
|
|
|
#### From Source
|
|
|
|
|
|
To run the tool from the sources you need to have[Node.js](https://nodejs.org/) installed. <br/>
|
|
|
It is recommend to always use the newest version. <br/>
|
|
|
Additionally you may need [Python](https://www.python.org/) for rebuilding native modules. <br/>
|
|
|
An Error will appear while building if that is the case. <br/>
|
|
|
For building purposes you also have to use [yarn](https://yarnpkg.com/lang/en/) instead of npm, otherwise you might get error while recompiling native modules (especially under window)
|
|
|
|
|
|
To build/start the app, first checkout the repo. <br/>
|
|
|
After that install any dependencies by running:
|
|
|
```sh
|
|
|
$ yarn
|
|
|
```
|
|
|
|
|
|
To start the app run:
|
|
|
```sh
|
|
|
$ yarn start
|
|
|
```
|
|
|
|
|
|
And done! <br/>
|
|
|
If you wan't to also build the app into an package, you can checkout the wiki entry for building the app [WIP]. |
|
|
\ No newline at end of file |