Skip to content

Commit db7074f

Browse files
authored
Update Dependencies (#13)
* Update Dependencies * Update npm
1 parent bdacf1d commit db7074f

File tree

10 files changed

+234
-323
lines changed

10 files changed

+234
-323
lines changed

.eslintrc.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@
1111
"sourceType": "module"
1212
},
1313
"rules": {
14-
"no-empty": "off",
1514
"no-extra-semi": "off",
16-
"no-func-assign": "off",
17-
"no-undef": "off",
18-
"no-unused-vars": "off"
15+
"no-undef": "off"
1916
}
2017
}

.github/workflows/build.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313

1414
steps:
1515
- name: "Checkout"
16-
uses: actions/checkout@v3
16+
uses: actions/checkout@v4
1717

1818
- name: "Release Version Check"
1919
if: ${{ github.event_name == 'release' }}
@@ -25,17 +25,17 @@ jobs:
2525
fi
2626
2727
- name: "Setup Node"
28-
uses: actions/setup-node@v3
28+
uses: actions/setup-node@v4
2929
with:
30-
node-version: 18
30+
node-version: 20
3131

3232
- name: "Build All"
3333
run: |
3434
npm install
3535
npm run build
3636
3737
- name: "Upload to Actions"
38-
uses: actions/upload-artifact@v3
38+
uses: actions/upload-artifact@v4
3939
with:
4040
name: artifacts
4141
path: web-ext-artifacts/

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ All **Chromium** Based Browsers can install the extension from the
3535

3636
# Features
3737

38+
* Patch or Play ROM's from the Popup
39+
* Patch or Play ROM's by Right-clicking Links
40+
3841
Please submit a [Feature Request](https://github.com/cssnr/smwc-web-extension/discussions/new?category=feature-requests) for new features.
3942
For any issues, bugs or concerns; please [Open an Issue](https://github.com/cssnr/smwc-web-extension/issues/new).
4043

@@ -48,22 +51,31 @@ You can pin the Addon by clicking the `Puzzle Piece`, find the SMWC Web Extensio
4851

4952
**Quick Start**
5053

51-
To install and run chrome or firefox with web-ext.
54+
First, clone (or download) this repository and change into the directory.
55+
56+
Second, install the dependencies:
5257
```shell
5358
npm isntall
59+
```
60+
61+
Finally, to run Chrome or Firefox with web-ext, run one of the following:
62+
```shell
5463
npm run chrome
5564
npm run firefox
5665
```
5766

58-
To Load Unpacked/Temporary Add-on make a `manifest.json` and run from the [src](src) folder.
67+
Additionally, to Load Unpacked/Temporary Add-on make a `manifest.json` and run from the [src](src) folder, run one of the following:
5968
```shell
6069
npm run manifest:chrome
6170
npm run manifest:firefox
6271
```
6372

73+
Chrome: [https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked)
74+
Firefox: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)
75+
6476
For more information on web-ext, [read this documentation](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/).
6577
To pass additional arguments to an `npm run` command, use `--`.
66-
Example: `npm run chrome -- --chromium-binary=...`
78+
Example: `npm run chrome -- --chromium-binary=...`
6779

6880
## Building
6981

@@ -73,25 +85,17 @@ See [gulpfile.js](gulpfile.js) for more information on `postinstall`.
7385
npm install
7486
```
7587

76-
To load unpacked or temporary addon from the [src](src) folder, you must generate the `src/manifest.json` for the desired browser.
77-
```shell
78-
npm run manifest:chrome
79-
npm run manifest:firefox
80-
```
81-
82-
If you would like to create a `.zip` archive of the [src](src) directory for the desired browser.
88+
To create a `.zip` archive of the [src](src) directory for the desired browser run one of the following:
8389
```shell
8490
npm run build
8591
npm run build:chrome
8692
npm run build:firefox
8793
```
8894

89-
For more information on building, see the scripts in the [package.json](package.json) file.
95+
For more information on building, see the scripts section in the [package.json](package.json) file.
9096

9197
## Chrome Setup
9298

93-
To install for production: https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide
94-
9599
1. Build or Download a [Release](https://github.com/cssnr/smwc-web-extension/releases).
96100
1. Unzip the archive, place the folder where it must remain and note its location for later.
97101
1. Open Chrome, click the `3 dots` in the top right, click `Extensions`, click `Manage Extensions`.
@@ -100,19 +104,14 @@ To install for production: https://chromewebstore.google.com/detail/smwc-web-ext
100104

101105
## Firefox Setup
102106

103-
To install for production: https://addons.mozilla.org/addon/smwc-web-extension
104-
105-
Note: Firefox Temporary addon's will **not** remain after restarting Firefox, therefore;
106-
it is very useful to keep addon storage after uninstall/restart with `keepStorageOnUninstall`.
107-
108107
1. Build or Download a [Release](https://github.com/cssnr/smwc-web-extension/releases).
109108
1. Unzip the archive, place the folder where it must remain and note its location for later.
110109
1. Go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`
111110
1. Navigate to the folder you extracted earlier, select `manifest.json` then click `Select File`.
112111
1. Open `about:config` search for `extensions.webextensions.keepStorageOnUninstall` and set to `true`.
113112

114-
If you need to test a build or browser restart, you must pack the addon.
115-
This only works in ESR, Development, or Nightly.
113+
If you need to test a restart, you must pack the addon. This only works in ESR, Development, or Nightly.
114+
You may also use an Unbranded Build: [https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds](https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds)
116115

117116
1. Run `npm run build:firefox` then use `web-ext-artifacts/{name}-firefox-{version}.zip`.
118117
1. Open `about:config` search for `xpinstall.signatures.required` and set to `false`.

manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "SMWC Web Extension",
3-
"description": "SMWC.world Web Extension and Browser Addon to Easily Patch and Play SMW ROMs.",
3+
"description": "SMWC.world Web Extension and Browser Addon to Easily Patch and Play SMW ROMs Online.",
44
"homepage_url": "https://smwc.world",
55
"author": "Shane",
6-
"version": "0.1.2",
6+
"version": "0.1.3",
77
"manifest_version": 3,
88
"commands": {
99
"_execute_action": {

0 commit comments

Comments
 (0)