erin/ffxiv-wiki-scripts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add note about one-time scripts

Browse source
This commit is contained in:
ewin 2025-08-12 19:02:54 -04:00
parent e1004215e1
commit b43b8837ef
Signed by: erin
SSH key fingerprint: SHA256:swjoHhREbZPbWe+gyJNi24d4NAxJSyUIm3fpZj4z3wc
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -5,6 +5,8 @@ Wiki bot scripts for https://ffxiv.consolegameswiki.com.
- `bin/add-edb-ids`: Attempts to fix items in [Category:Missing EDB ID](https://ffxiv.consolegameswiki.com/wiki/Category:Missing_EDB_ID) by looking them up in Eorzea Database and adding the appropriate `id-edb` infobox parameter. - `bin/add-edb-ids`: Attempts to fix items in [Category:Missing EDB ID](https://ffxiv.consolegameswiki.com/wiki/Category:Missing_EDB_ID) by looking them up in Eorzea Database and adding the appropriate `id-edb` infobox parameter.
- `bin/add-gt-ids`: The same for [Category:Missing internal ID](https://ffxiv.consolegameswiki.com/wiki/Category:Missing_EDB_ID), looking up internal IDs via [XIVAPI](https://v2.xivapi.com) and populating the `id-gt` parameter. - `bin/add-gt-ids`: The same for [Category:Missing internal ID](https://ffxiv.consolegameswiki.com/wiki/Category:Missing_EDB_ID), looking up internal IDs via [XIVAPI](https://v2.xivapi.com) and populating the `id-gt` parameter.
Scripts for other one-time maintenance tasks (e.g. bulk renames) can be found for `bin/one-time`, mostly just in case I need to repurpose them for other stuff in the future.
## Usage ## Usage
You'll need a recent version of Node.js (22+). Install dependencies via `npm ci`, set the `MW_USERNAME` and `MW_PASSWORD` environment variables to your account username and [bot password](https://www.mediawiki.org/wiki/Manual:Bot_passwords) respectively, then run the scripts in the `bin` folder. You'll need a recent version of Node.js (22+). Install dependencies via `npm ci`, set the `MW_USERNAME` and `MW_PASSWORD` environment variables to your account username and [bot password](https://www.mediawiki.org/wiki/Manual:Bot_passwords) respectively, then run the scripts in the `bin` folder.