Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Latest commit

 

History

History
99 lines (64 loc) · 2.48 KB

1_INSTALLING.md

File metadata and controls

99 lines (64 loc) · 2.48 KB

Warning

These instructions are only for advanced users. If you're not a Developer, you should use our graphical installer instead. No support will be provided for installing in this fashion. If you cannot figure it out, you should just stick to a regular install.

Installation Guide

Welcome to Megu's Installation Guide! In this file, you will learn about how to download, install, and uninstall Suncord!

Sections

Dependencies

Installing Suncord

Install pnpm:

❗ This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH.

npm i -g pnpm

IMPORTANT Make sure you aren't using an admin/root terminal from here onwards. It will mess up your Discord/Suncord instance and you will most likely have to reinstall.

Clone Suncord:

git clone https://github.com/verticalsync/Suncord
cd Suncord

Install dependencies:

pnpm install --frozen-lockfile

Build Suncord:

pnpm build

Inject Suncord into your client:

pnpm inject

Then fully close Discord from your taskbar or task manager, and restart it. Suncord should be injected - you can check this by looking for the Suncord section in Discord settings.

Updating Suncord

If you're using Discord already, go into the Updater tab in settings.

Sometimes it may be necessary to manually update if the GUI updater fails.

To pull latest changes:

git pull

If this fails, you likely need to reset your local changes to suncord to resolve merge errors:

❗ This command will remove any local changes you've made to suncord. Make sure you back up if you made any code changes you don't want to lose!

git reset --hard
git pull

and then to build the changes:

pnpm build

Then just refresh your client

Uninstalling Suncord

Simply run:

pnpm uninject

If you need more help, ask in the support channel in our Discord Server.