137 lines
No EOL
5.3 KiB
Markdown
137 lines
No EOL
5.3 KiB
Markdown
+++
|
|
title = "MacOS Guide"
|
|
description = "How to set up EllieBot on MacOS"
|
|
weight = 5
|
|
+++
|
|
|
|
{{% notice style="note" title="Notice on macOS installer" %}}
|
|
~~There is an easier way in the works but this will take time to make, sorry about that. - Toastie~~
|
|
|
|
This way of installing and using Ellie is nearly ready so keep and eye out for that part of the guide. - Toastie
|
|
{{% /notice %}}
|
|
|
|
## MacOS From Source
|
|
|
|
Open Terminal (if you don't know how to, click on the magnifying glass on the top right corner of your screen and type **Terminal** on the window that pops up) and navigate to the location where you want to install the bot (for example `cd ~`)
|
|
|
|
##### Installing Homebrew, wget and dotnet
|
|
|
|
###### Homebrew/wget
|
|
*Skip this step if you already have homebrew installed*
|
|
- Copy and paste this command, then press Enter:
|
|
- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
|
|
- Install wget
|
|
- `brew install wget`
|
|
|
|
###### Dotnet
|
|
- Download [.net8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
|
|
- Open the `.pkg` file you've downloaded and install it.
|
|
- Run this command in Terminal. There might be output. If there is, disregard it. (copy-paste the entire block)
|
|
```bash
|
|
sudo mkdir /usr/local/bin
|
|
|
|
sudo mkdir /usr/local/lib
|
|
```
|
|
- Run this command in Terminal. There won't be any output. (copy-paste the entire block):
|
|
```bash
|
|
sudo ln -s /usr/local/share/dotnet/dotnet /usr/local/bin
|
|
|
|
sudo ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
|
|
|
|
sudo ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
|
|
```
|
|
|
|
##### Installation Instructions
|
|
|
|
1. Download and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
|
|
2. Install prerequisites (type `1` and press enter)
|
|
3. Download the bot (type `2` and press enter)
|
|
4. Exit the installer in order to set up your `creds.yml`
|
|
5. Copy the creds.yml template
|
|
`cp elliebot/output/creds_example.yml elliebot/output/creds.yml`
|
|
6. Open `elliebot/output/creds.yml` with your favorite text editor. We will use nano here
|
|
- `nano elliebot/output/creds.yml`
|
|
7. [Enter your bot's token](#creds-guide)
|
|
- After you're done, you can close nano (and save the file) by inputting, in order
|
|
- `CTRL`+`X`
|
|
- `Y`
|
|
- `Enter`
|
|
8. Run the bot (type `3` and press enter)
|
|
|
|
##### Update Instructions
|
|
|
|
1. ⚠ Stop the bot
|
|
2. Update and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
|
|
3. Update the bot (type `2` and press enter)
|
|
4. Run the bot (type `3` and press enter)
|
|
5. 🎉
|
|
|
|
## MacOS Manual Release installation instructions
|
|
|
|
⚠ IF YOU ARE FOLLOWING THE GUIDE ABOVE, IGNORE THIS SECTION ⚠
|
|
|
|
##### Installation Instructions
|
|
|
|
1. Download the latest release from <https://toastielab.dev/EllieBotDevs/elliebot/releases>
|
|
- Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it
|
|
2. Untar it
|
|
⚠ Make sure that you change X.XX.X to the same series of numbers as in step 1!
|
|
- `tar xf X.XX.X-linux-x64-build.tar`
|
|
3. Rename the `elliebot-linux-x64` to `elliebot`
|
|
- `mv elliebot-linux-x64 elliebot`
|
|
4. Move into elliebot directory and make EllieBot executable
|
|
- `cd elliebot && chmod +x EllieBot`
|
|
5. Copy the creds.yml template
|
|
- `cp creds_example.yml creds.yml`
|
|
6. Open `creds.yml` with your favorite text editor. We will use nano here
|
|
- `nano elliebot/output/creds.yml`
|
|
8. [Enter your bot's token](#creds-guide)
|
|
- After you're done, you can close nano (and save the file) by inputting, in order
|
|
- `CTRL`+`X`
|
|
- `Y`
|
|
- `Enter`
|
|
9. Run the bot
|
|
- `./EllieBot`
|
|
|
|
##### Update Instructions
|
|
|
|
1. Stop the bot
|
|
2. Download the latest release from <https://toastielab.dev/EllieBotDevs/elliebot/releases>
|
|
- Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it
|
|
3. Untar it
|
|
⚠ Make sure that you change X.XX.X to the same series of numbers as in step 2!
|
|
- `tar xf 2.99.8-linux-x64-build.tar`
|
|
4. Rename the old elliebot directory to elliebot-old (remove your old backup first if you have one, or back it up under a different name)
|
|
- `rm -rf elliebot-old 2>/dev/null`
|
|
- `mv elliebot elliebot-old`
|
|
5. Rename the new elliebot directory to elliebot
|
|
- `mv elliebot-linux-x64 elliebot`
|
|
6. Remove old strings and aliases to avoid overwriting the updated versions of those files
|
|
⚠ If you've modified said files, back them up instead
|
|
- `rm elliebot-old/data/aliases.yml`
|
|
- `rm -r elliebot-old/data/strings`
|
|
7. Copy old data
|
|
- `cp -RT elliebot-old/data/ elliebot/data/`
|
|
8. Copy creds.yml
|
|
- `cp elliebot-old/creds.yml elliebot/`
|
|
9. Move into elliebot directory and make the EllieBot executable
|
|
- `cd elliebot && chmod +x EllieBot`
|
|
10. Run the bot
|
|
- `./EllieBot`
|
|
|
|
🎉 Enjoy
|
|
|
|
##### Steps 3 - 9 as a single command
|
|
|
|
Don't forget to change X.XX.X to match step 2.
|
|
```sh
|
|
tar xf X.XX.X-linux-x64-build.tar && \
|
|
rm -rf elliebot-old 2>/dev/null && \
|
|
mv elliebot elliebot-old && \
|
|
mv elliebot-linux-x64 elliebot && \
|
|
rm elliebot-old/data/aliases.yml && \
|
|
rm -r elliebot-old/data/strings && \
|
|
cp -RT elliebot-old/data/ elliebot/data/ && \
|
|
cp elliebot-old/creds.yml elliebot/ && \
|
|
cd elliebot && chmod +x EllieBot
|
|
``` |