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

Commit

Permalink
deploy: b699edd
Browse files Browse the repository at this point in the history
  • Loading branch information
smartfrigde committed Jun 16, 2024
1 parent e1196a7 commit 847b922
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 70 deletions.
40 changes: 5 additions & 35 deletions 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,10 @@ permalink: /404.html
---
> **Note:** You accessed a link that returned a 404, probably by clicking one of the plugin links. You're supposed to copy the link address and add it into shelter.
# [Your name here]'s shelter plugins
If you're reading this you should either change this README,
or you should run `npx degit uwu/shelter-template shelter-plugins`!
# ArmCord shelter plugins
A few plugins will allow you to use ArmCord/Discord Web to its fullest potential.

## Getting started
You should be using [pnpm](https://pnpm.io/) with this template ideally.
## Screenshare Quality Fix
Let's you change screenshare quality in ArmCord/Discord Web.

To install the dependencies and debug `hello-world` run:
```sh
pnpm i
pnpm lune dev plugins/hello-world
```

Ensure that Lune Dev Mode is enabled in Discord so that lune can connect to it.

Now you can start debugging. The plugin will automatically reload after every change.

## Installing
To then install your finished plugin in shelter you can either rely on GitHub pages and it's workflow or you can build and host them here temporarily.

### Building locally
To build and host your plugins locally run:
```sh
pnpm lune ci
npx http-server dist/ --cors
```
Then you can install your plugin in shelter with this URL `http://localhost:8080/hello-world`.

### Publishing via GitHub
If you have published this repo on GitHub the plugins will be built after every commit.

For the GitHub action to run flawlessly, make sure you have the following setting enabled:
`Repo settings > Actions > General > Workflow permissions > Read and write permissions`

And for it to be hosted correctly you need to configure the `gh-pages` branch after its been created by the GitHub action. You can do this in `Repo settings > Pages > Branch`.

If this worked, you will be able to install the plugin via `https://<username>.github.io/<repo>/hello-world`.
`https://armcord.github.io/shelter-plugins/screenshareQualityFix/`
40 changes: 5 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,7 @@
# [Your name here]'s shelter plugins
If you're reading this you should either change this README,
or you should run `npx degit uwu/shelter-template shelter-plugins`!
# ArmCord shelter plugins
A few plugins will allow you to use ArmCord/Discord Web to its fullest potential.

## Getting started
You should be using [pnpm](https://pnpm.io/) with this template ideally.
## Screenshare Quality Fix
Let's you change screenshare quality in ArmCord/Discord Web.

To install the dependencies and debug `hello-world` run:
```sh
pnpm i
pnpm lune dev plugins/hello-world
```

Ensure that Lune Dev Mode is enabled in Discord so that lune can connect to it.

Now you can start debugging. The plugin will automatically reload after every change.

## Installing
To then install your finished plugin in shelter you can either rely on GitHub pages and it's workflow or you can build and host them here temporarily.

### Building locally
To build and host your plugins locally run:
```sh
pnpm lune ci
npx http-server dist/ --cors
```
Then you can install your plugin in shelter with this URL `http://localhost:8080/hello-world`.

### Publishing via GitHub
If you have published this repo on GitHub the plugins will be built after every commit.

For the GitHub action to run flawlessly, make sure you have the following setting enabled:
`Repo settings > Actions > General > Workflow permissions > Read and write permissions`

And for it to be hosted correctly you need to configure the `gh-pages` branch after its been created by the GitHub action. You can do this in `Repo settings > Pages > Branch`.

If this worked, you will be able to install the plugin via `https://<username>.github.io/<repo>/hello-world`.
`https://armcord.github.io/shelter-plugins/screenshareQualityFix/`

0 comments on commit 847b922

Please sign in to comment.