Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ioj4 committed Feb 25, 2024
1 parent 5e48d9c commit 8b474a6
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,22 @@ or you should run `npx degit uwu/shelter-template shelter-plugins`!

You should be using pnpm with this template ideally.

You can build all plugins with `pnpm lune ci`.
To get started run `pnpm i` and `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 any change that you made.

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

To build the plugins run `pnpm lune ci`. This will place the built plugins in `dist/`.
You can host that directory with `npx http-server dist --cors`.
Then you can install your plugin in shelter with this URL `http://localhost:8080/hello-world`.

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 you need to select 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`

0 comments on commit 8b474a6

Please sign in to comment.