Candlestick is a fork of Wick Editor, a free and open-source tool for creating games, animations, and everything in-between.
We plan to update our Node packages in the future. Until then, you will need to use Node Version 14 to install the right packages. If using an M-series Mac, this will require installing Rosetta 2.
See the original Wick Editor README for older instructions. Newer instructions are provided below, with a focus on Mac development.
This is optional as you can download things without, but Homebrew is a simple set of command line tools that make the process easier. We recommend downloading it if you haven't already. Quick Homebrew check—
brew --version
If nothing returns you can download it with this command
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
You may need Python 3.10 to be able to run some of the packages that come with Candlestick. First check if you already have Python
python3 --version
If nothing returns, then run
brew install [email protected]
Then run the version command at the end as a check. If you would like to install Python without Homebrew, you can download it from their site here, and for more detailed steps check out this article.
(nvm = Node Version Manager)
nvm is a CLI library that helps you manage the Node versions you have installed on your device. You should be able to install Node versions directly from online, but as we're going for a specific older version and to be more organized, we recommend installing nvm. Run a quick nvm check to see if you have it installed—
nvm ls
This command lists all the node versions you have. If you installed the node version without nvm then the command may not catch the node you have installed or it may not even be downloaded at all. To install nvm, you can follow the steps here: https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating
Or just paste this command into your terminal:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
which downloads the nvm code to an nvm directory on your system. Try running nvm ls or nvm --version afterwards, and if you get nothing from both then go back to this link and follow the instructions.
If you're on Windows, please see nvm-windows.
Wick Editor is a software that hasn't been updated in ~5 years before we picked it back up with our fork. For that reason though, it requires an older version of Node.
Try first running this command to install Node v14:
nvm install 14
There's a chance this works, and if it does you may move on to the next step. If it doesn't work, and you're on a Mac device with an M-series chip, the issue is likely because Node v14 doesn't have ARM64 support, so you'll likely need to install Rosetta 2 to work around this issue.
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
Then use it to change the arch
arch -x86_64 zsh
Then re-run nvm install.
nvm install 14
For anyone on Windows, you won't need this step
Things usually get resolved after this. If you still have an error, let us know what it says.
Side Note: When nvm installs v14, it uses it by default. You can run nvm ls to check that it is, if you don't see an arrow next to version 14._._ then run nvm use 14 and re-check.
You need to navigate to your project file... if you don't know how to navigate through the terminal then you may use this online video tutorial to learn how. It's simple but takes a minute to explain.
If you haven't downloaded our repository yet then do that by either downloading the zip, or using git clone
git clone https://github.com/Candlestickers/Candlestick.git
cd Candlestick
-#(You may also need to download git first using brew install git, or download Git through this online website)
If you have the repository set up, then navigate to the directory and run the following command to install the npm packages:
npm install
(If at any point you switched terminals, please make sure you're still using npm v14 before running the last command, npm install. To ensure you're using npm v14, you may run nvm use 14, if you have nvm set up successfully)
You may see a few warnings, like ummmm... a little over 300... due to the outdated packages... but don't worry about em' 😅 As long as things download successfully, it's fine.
Programming rule #1, if things work, don't touch it... don't worry though those are things we're slowly fixing
If the terminal says something like found 0 vulnerabilities after only 7 lines of loading or such, then there's a change you're in the wrong directory.
Once you have everything setup, all you need to do to test your app is... first build the engine:
npm run build-engine
^ You'll also need to do this step every time you make changes to your /engine directory to be able to see changes
Then create a production build of the project:
npm run build
^ This command is not always needed while testing, you'll need it most prior to deploying your code
And lastly, to run your project in development:
npm start
If it worked, you should see something like this in the terminal.
Compiled successfully!
You can now view Candlestick in the browser.
Local: http://localhost:3000/
On Your Network: http://###.###.#.###:3000/
If you go to your browser and open up http://localhost:3000/ you should find the project there. You can also test on your mobile devices by going to the network http://###.###.#.###:3000/ link on another device connected to the same network (it should work, but if it doesn't, it could be due to certain network restrictions).
Well that's all! If you have any trouble with the process above, you can ask us for help on our Discord server!
Candlestick is under the GNU v3 Public License. See the LICENSE for more information.
Wick Editor was created by Luca Damasco and Zach Rispoli. See more credits on the Wick Editor About Page and Credits.
Candlestick was created and is maintained by Hamzah Alani, Baron, and Jovanny Rodriguez.
Active contributors:
Additional, indirect contributors:
These legal Terms and Conditions listed below and within our software are a legal agreement between you (either as an individual or on behalf of an entity) and our team ("Candlestickers") regarding your use of Candlestickers' applications, such as Candlestick. These terms apply to the executable code version of the Software as well. Source code for the Software is available separately and free of charge under open source software license agreements. If you do not agree to all of our listed terms below and within the software, do not download, install, use, or copy the Software.
Disclaimers and Limitations of Liability
THE SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND NO WARRANTY, EITHER EXPRESS OR IMPLIED, IS GIVEN. YOUR USE OF THE SOFTWARE IS AT YOUR SOLE RISK. Candlestickers does not warrant that (i) the Software will meet your specific requirements; (ii) the Software is fully compatible with any particular platform; (iii) your use of the Software will be uninterrupted, timely, secure, or error-free; (iv) the results that may be obtained from the use of the Software will be accurate or reliable; (v) the quality of any products, services, information, or other material purchased or obtained by you through the Software will meet your expectations; or (vi) any errors in the Software will be corrected. YOU EXPRESSLY UNDERSTAND AND AGREE THAT CANDLESTICKERS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES, INCLUDING BUT NOT LIMITED TO, DAMAGES FOR LOSS OF PROFITS, GOODWILL, USE, DATA OR OTHER INTANGIBLE LOSSES (EVEN IF CANDLESTICKERS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES) RELATED TO THE SOFTWARE, including, for example: (i) the use or the inability to use the Software; (ii) the cost of procurement of substitute goods and Software resulting from any goods, data, information or Software purchased or obtained or messages received or transactions entered into through or from the Software; (iii) unauthorized access to or alteration of your transmissions or data; (iv) statements or conduct of any third-party on the Software; (v) or any other matter relating to the Software. Candlestickers reserves the right at any time and from time to time to modify or discontinue, temporarily or permanently, the Software (or any part thereof) with or without notice. Candlestickers shall not be liable to you or to any third-party for any price change, suspension or discontinuance of the Software.
Miscellanea
- No Waiver. The failure of Candlestickers to exercise or enforce any right or provision of these Application Terms shall not constitute a waiver of such right or provision.
- Entire Agreement. These Application Terms, together with any applicable Privacy Notices, constitutes the entire agreement between you and Candlestickers and governs your use of the Software, superseding any prior agreements between you and Candlestickers (including, but not limited to, any prior versions of the Application Terms).
- Governing Law. You agree that these Application Terms and your use of the Software are governed under New York law and any dispute related to the Software must be brought in a tribunal of competent jurisdiction located in or near Rochester, New York.
- Third-Party Packages. The Software supports third-party "Packages" which may modify, add, remove, or alter the functionality of the Software. These Packages are not covered by these Application Terms and may include their own license which governs your use of that particular package.
- Complete Agreement. These Application Terms, together with any applicable Open Source Licenses and Notices and Candlestickers' Privacy Statement, represent the complete and exclusive statement of the agreement between you and us. These Application Terms supersede any proposal or prior agreement oral or written, and any other communications between you and Candlestickers relating to the subject matter of these terms.
- These Application Terms are licensed under the Creative Commons Attribution license. You may use it freely under the terms of the Creative Commons license.
- Contact Us. Please send any questions about these Application Terms to [email protected]. These terms and conditions were adapted and modified from the GitHub Open Source Applications Terms and Conditions