diff --git a/docs/md/assets/elliehub-1.png b/docs/md/assets/elliehub-1.png new file mode 100644 index 0000000..3b09e60 Binary files /dev/null and b/docs/md/assets/elliehub-1.png differ diff --git a/docs/md/assets/elliehub-2.png b/docs/md/assets/elliehub-2.png new file mode 100644 index 0000000..42a327a Binary files /dev/null and b/docs/md/assets/elliehub-2.png differ diff --git a/docs/md/assets/elliehub-3.png b/docs/md/assets/elliehub-3.png new file mode 100644 index 0000000..2117cc2 Binary files /dev/null and b/docs/md/assets/elliehub-3.png differ diff --git a/docs/md/assets/elliehub-4.png b/docs/md/assets/elliehub-4.png new file mode 100644 index 0000000..efd8f1a Binary files /dev/null and b/docs/md/assets/elliehub-4.png differ diff --git a/docs/md/assets/elliehub-5.png b/docs/md/assets/elliehub-5.png new file mode 100644 index 0000000..49c359a Binary files /dev/null and b/docs/md/assets/elliehub-5.png differ diff --git a/docs/md/assets/elliehub-6.png b/docs/md/assets/elliehub-6.png new file mode 100644 index 0000000..74e6cd8 Binary files /dev/null and b/docs/md/assets/elliehub-6.png differ diff --git a/docs/md/creds-guide.md b/docs/md/creds-guide.md index 4454024..8bf285a 100644 --- a/docs/md/creds-guide.md +++ b/docs/md/creds-guide.md @@ -20,7 +20,7 @@ This guide will show you how to create your own discord bot, invite it to your s  -- On the **General Information** tab, copy your `Application ID` from your [applications page][DiscordApp]. +- On the **General Information** tab, copy your `Application ID` from your [applications page][Discord]. - Replace the `YOUR_CLIENT_ID_HERE` in this link: `https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303` with your `Client ID` - The link should now look something like this: diff --git a/docs/md/donate.md b/docs/md/donate.md index d2b69a9..7e1876c 100644 --- a/docs/md/donate.md +++ b/docs/md/donate.md @@ -8,15 +8,15 @@ Donations go a long way in helping us keep the project alive, and we appreciate Donating to us also gives you the following benefits: - A hoisted **Patron** role in [Ellie Discord server][discord-server] -- Access to exclusive **#noticed** text and voice channels -- **3000 flowers** on the public bot per dollar donated (after fees) +- Access to exclusive **#donator-general** text and voice channels +- **3000 candy** on the public bot per dollar donated (after fees) ## Patreon -You can set up a monthly pledge on [Patreon][patreon] and support the project's growth, and also get flower rewards for every month you donate! +You can set up a monthly pledge on [Patreon][patreon] and support the project's growth, and also get candy rewards for every month you donate! !!! Note - Connect your Discord account on Patreon to receive your flowers automatically + Connect your Discord account on Patreon to receive your candy automatically [![img][patreon-button]][patreon] @@ -25,7 +25,7 @@ You can set up a monthly pledge on [Patreon][patreon] and support the project's You can also donate to us through [PayPal][paypal] for one-time donations using the button below, or by donating to `toastie@dragonschildstudios.com`. !!! Note - Mention your Discord username or user id in the payment note to receive flower rewards. + Mention your Discord username or user id in the payment note to receive candy rewards. [![img][paypal-button]][paypal] diff --git a/docs/md/guides/cli-guide.md b/docs/md/guides/cli-guide.md index 6dc4d5b..300a289 100644 --- a/docs/md/guides/cli-guide.md +++ b/docs/md/guides/cli-guide.md @@ -28,6 +28,9 @@ Linux: ## Installation Instructions +!!! failure + This script is broken and should no be used. please use [Desktop Guide](../guides/desktop-guide.md) + Open Terminal (if you're on an installation with a window manager) and navigate to the location where you want to install the bot (for example `cd ~`) 1. First make sure that curl is installed diff --git a/docs/md/guides/desktop-guide.md b/docs/md/guides/desktop-guide.md index b7abc94..76d919c 100644 --- a/docs/md/guides/desktop-guide.md +++ b/docs/md/guides/desktop-guide.md @@ -1,2 +1,53 @@ -!!! info - Coming soon! \ No newline at end of file +# EllieBot Desktop Guide (via EllieHub) + +### Supported Operating Systems + +--8<-- "md/snippets/supported-platforms.md" + +--- + +??? note "Creating a Discord Bot & Getting Credentials" + --8<-- "md/creds-guide.md" + +--- + +## Setup + +1. Download and run [elliehub](https://toastielab.dev/EllieBotDevs/EllieHub/releases/latest). + +  + +2. Click the plus button to add a new bot + +  + +3. If you want to use the music module, click on the settings icon then click **`Install`** next to `ffmpeg` and `yt-dlp` near the top of the setting tab. +4. Click on the newly created bot + +5. Click on **Install** located above the live console (This may take a bit) + + + + +6. When installation is finished, click on **`CREDS`** (`1`) above the **`RUN`** (`3`) button on the lower left + - **`2`** simply opens your bot's data folder. +7. Paste in your **BOT TOKEN** previously obtained + +## Starting EllieBot + +- Either click on **`RUN`** button in the updater or run the bot via its desktop shortcut. + +## Updating EllieBot + +!!! warning "IMPORTANT" + + - Make sure Ellie is closed and not running + - Run `.die` in a connected server to make sure. + - Make sure you don't have `data` folder, bot folder, or any other bot file open in any program, as the updater will fail to replace your version + +1. Run `elliehub` if not already running +2. Click on your bot +3. Click on **`Check for updates`** +4. If updates are available, you will be able to click on the Update button +5. Click `Update` +6. Click `RUN` after it's done \ No newline at end of file diff --git a/docs/md/guides/source-guide.md b/docs/md/guides/source-guide.md index 46bb178..ac4b16f 100644 --- a/docs/md/guides/source-guide.md +++ b/docs/md/guides/source-guide.md @@ -26,7 +26,7 @@ Open PowerShell (press windows button on your keyboard and type powershell, it s 3. `cd elliebot/src/EllieBot` 4. `dotnet build -c Release` 5. `cp data/creds_example.yml data/creds.yml` -6. "You're done installing, you may now proceed to set up your bot's credentials by following the [#creds-guide] +6. "You're done installing, you may now proceed to set up your bot's credentials by following the creds guide - Once done, come back here and run the last command 6. Run the bot `dotnet EllieBot.dll` 7. 🎉 Enjoy diff --git a/docs/md/index.md b/docs/md/index.md index 671146a..2b67564 100644 --- a/docs/md/index.md +++ b/docs/md/index.md @@ -34,7 +34,7 @@ If you're unsure whether something is an issue, ask in our support server first. [cli-guide]: ./guides/cli-guide.md [docker-guide]: ./guides/docker-guide.md [from-source-guide]: ./guides/source-guide.md -[discord-server]: https://discord.elliebot.net/ +[discord-server]: https://discord.gg/etQdZxSyEH [toastielab]: https://toastielab.dev/EllieBotDevs/elliebot [issues]: https://toastielab.dev/EllieBotDevs/elliebot/issues [donate]: ./donate.md \ No newline at end of file diff --git a/docs/md/marmalade/getting-started.md b/docs/md/marmalade/getting-started.md index 12ea0c7..dc0ba6a 100644 --- a/docs/md/marmalade/getting-started.md +++ b/docs/md/marmalade/getting-started.md @@ -23,8 +23,9 @@ Follow the [creating a marmalade guide](creating-a-marmalade.md) ### Where to get marmalades other people made? ⚠*It is EXTREMELY, and I repeat **EXTREMELY** dangerous to run marmalades of strangers or people you don't FULLY trust.* ⚠+ ⚠*It can not only lead to your bot being stolen, but it also puts your entire computer and personal files in jeopardy.* ⚠**It is strongly recommended to run only the marmalades you yourself wrote, and only on a hosted VPS or dedicated server which ONLY hosts your bot, to minimize the potential damage caused by bad actors.** -No easy way at the moment, except asking in the `#dev-and-modding` chat in [#Ellie's Home server](https://discord.gg/etQdZxSyEH) \ No newline at end of file +No easy way at the moment, except asking in the `#dev-and-modding` chat in [Ellie's Home server](https://discord.gg/etQdZxSyEH) \ No newline at end of file