Halyde Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Quickstart guide ======
**This page is under construction**

**Information is not guaranteed to be accurate or complete**

----

Welcome to the Halyde quickstart guide! This guide will show you how to get Halyde up and running.

To install Halyde, you will need:
  * A computer
  * An internet card
  * Storage to install to
  * OpenOS floppy

There are 2 versions of Halyde you can install:
  * [[quickstart#installing_halyde_2|Halyde 2 (latest release)]]
  * [[quickstart#installing_halyde_3|Halyde 3 (beta version)]]

----

====== Installing Halyde 2 ======
To install Halyde 2, you can use the Halyde webinstaller.

First you must boot into OpenOS, either through an already installed copy or from the installer floppy. Once you're in, paste in the following command: ''pastebin run MB21BTMv''

If that doesn't work for some reason, try: ''wget -f https://raw.githubusercontent.com/Team-Cerulean-Blue/Halyde/refs/heads/main/webinstall.lua /tmp/webinstall.lua && /tmp/webinstall.lua''

Once you run the installer, you will be greeted with the disk selection screen. If you have one drive that can be installed to on your computer, you will see a screen like this.

{{:help:quickstart-a.png?400|}}
== Figure A ==
You can press Y to install Halyde, or N to cancel and exit the installer. **Installing Halyde will erase all data on the disk!**

If you instead have 2 or more drives that you can install Halyde to, you will see a screen like this.

{{:help:quickstart-b.png?400|}}
== Figure B ==
Use the up and down arrow keys to select a drive and press Enter. You will then be brought to a screen that looks like Figure A, and you can follow the same instructions there.

Once you start installing, a progress bar will display on the bottom and show how much has been installed. After installation is complete, the computer will automatically reboot into Halyde.
----

====== Installing Halyde 3 ======
Installing Halyde 3 is a bit more of an involved process. Please note that Halyde 2 apps are **not compatible** with Halyde 3.

There are 3 main ways of installing Halyde 3, but first you must pick the flavor, or branch, of Halyde 3 you would like to install.

Currently there are 2 options available:
  * ''cutting-edge'', more stable (recommended to use)
  * ''bleeding-edge'', newer but less stable (recommended for development)

You can either:
  * [[quickstart#installing_halyde_3_using_gitget|Install Halyde 2 and use the gitget tool to download Halyde 3]]
  * [[quickstart#downloading_halyde_3_from_gitea|Download Halyde 3 as a ZIP file from Gitea]]
  * [[quickstart#using_git_to_download_halyde_3|Use Git to download Halyde 3]]

----

===== Installing Halyde 3 using gitget =====
This method assumes you have [[quickstart#installing_halyde_2|installed Halyde 2]] and currently have an internet card. It is also the only way to install Halyde 3 when you cannot directly access the folder of your drive (i.e. on a server you don't own).

First, run the command ''ag install gitget'', then press ''Y''. This will use Halyde's Argentum package manager to install the ''gitget'' tool. Then, run ''gitget''.

The tool will prompt you for a repository name. Type ''Team-Cerulean-Blue/Halyde'' and hit Enter.

Next, it will ask you for a branch name. Type in the branch you chose in [[quickstart#installing_halyde_3|the previous section]] and hit Enter.

Then, it will ask you where to download to. You should enter a drive short ID (like ''b79'' for example) corresponding to where you want to install Halyde 3 and hit Enter.

Finally, it will ask you to confirm the install path. It should look something like ''/mnt/b79/''. Before confirming, check what you have entered in with the image below, keeping in mind that the branch should correspond to your selection, and the install path should correspond to your disk.

{{:help:quickstart-c.png?400|}}
== Figure C ==
Once you have checked to make sure everything is correct, type ''Y'' and hit Enter. If the details are incorrect, type ''N'' instead and hit Enter, then run ''gitget'' again and start over.

After confirming, the download process will start. This could take a few minutes, so wait for the completion message.

Once finished, you can run ''boot <drive id>'', replacing ''<drive id>'' with the actual ID or short ID where you installed Halyde 3, like ''boot b79''.

If you want to update Halyde 3, you will need to download it using ''gitget'' again. Currently, no version of ''gitget'' exists for Halyde 3 so you will need Halyde 2 to be able to update.
----

===== Downloading Halyde 3 from Gitea =====
//This method requires that you have access to the folder where your drive is. If you do not have that, try [[quickstart#installing_halyde_3_using_gitget|using gitget]].//

To download Halyde 3 from Gitea, first you must locate the folder for the drive you want to install to. Instructions are provided for Minecraft and Ocelot.

To do this, first locate your ''.minecraft'' folder. Then, go to ''.minecraft/saves/<the folder containing your world>/opencomputers/<the ID of your drive>''.

If you are using Ocelot, the folder for you drive will be in the root of your Ocelot folder.

This folder will be referred to as the "drive folder" in this guide. If you came from the guide for using Git, [[quickstart#using_git_to_download_halyde_3|return back now.]]

Once you have found your drive folder, head to [[https://git.sting.lt/Cerulean-Blue/Halyde|the Halyde Git repo]] and click the branch icon as shown in Figure D.

{{:help:quickstart-d.png?400|}}
== Figure D ==
Then, select the branch you chose in [[quickstart#installing_halyde_3|the previous section]].

Click the blue "''<>'' Code" button, then click "Download ZIP". This should start downloading a zip file containing Halyde 3.

Once it's done downloading, extract the zip file into your drive folder. You have now installed Halyde 3.

To update, you must redownload the zip file and paste it into the folder. This will update your Halyde system files without touching files that it shouldn't.
----

===== Using Git to download Halyde 3 =====
//This method requires that you have access to the folder where your drive is. If you do not have that, try [[quickstart#installing_halyde_3_using_gitget|using gitget]].//

//This method also involves using the terminal, as well as knowledge of how to use one. If you are not comfortable with that, [[quickstart#downloading_halyde_3_from_gitea|download Halyde 3 from Gitea]].//

//This method also requires you to install [[https://git-scm.com/|Git]]//.

First, you must find your drive folder. This is explained in [[quickstart#downloading_halyde_3_from_gitea|downloading from Gitea]].

Then, open a terminal and go to your drive folder. Once you're there, run ''git clone https://git.sting.lt/Cerulean-Blue/Halyde.git''. Then, run ''git switch <branch name>'', replacing ''<branch name>'' with the branch you chose in [[quickstart#installing_halyde_3|the previous section]].

Once you've done that, Halyde 3 should be installed. To update, run ''git pull''.