Development

This page is still WIP and may be incomplete!

Build instructions

• (WINDOWS) Install the required Visual Studio tools to build the native Node.js modules (see this for instructions)
• (LINUX) Install the required package to build the native Node.js modules, libudev
  • For example on Debian/Ubuntu, run sudo apt install libudev-dev in a terminal
• Run pip install setuptools with Python 3.12 in a terminal
• Clone the project - git clone https://github.com/OCSYT/SlimeTora.git
• Install the dependencies - npm i
• Start the dev environment - npm start or npm run dev (doesn't remove dist/ folder)
• Make your changes and build - npm run build (creates folders and zips under build/)
  • Note that the OS you are developing on will be the only build artifact made that will work (yay!!!). GitHub Actions is used to build both Windows and Linux builds for distribution.

SlimeTora's code

WIP (explanation of what the code does, pretty much)