Preparation

Ensure you have checked out the patches branch. This branch contains the most up-to-date file specs contained in this repo.
You can look around the outstanding pull requests as well, as some of those may have even more updated file specs.

Exporting

A sample item export command looks like this

pypoe_exporter wiki items item name "Celestial Necrolord Gloves" -p

In which the -p is the option to print the output in your console

You can replace it with --write (or -wr) to output the mediawiki code as .txt file. Note that since file names cannot have ":" in Windows, some item exports cannot be written to text file due to this (e.g. some Contracts).

There are other variations to the command which let you choose what items to export in other ways.

Here is the id-based export:

pypoe_exporter wiki items item id Metadata/Items/MicrotransactionItemEffects/MicrotransactionCelestialNecrolordGloves -p

Which export the same item but using the game's internal id. As mentioned in above paragraph, the -p can be replaced with other output option

For large scale exporting, you can specify a rowid range to output:

pypoe_exporter wiki items item rowid 0 1000 --write

Note that in the above command, 0 1000, means the first 1000 items will get exported. Note that the row with an index of 0 (the first row) will get exported but the row with an index of 1000 (the 1001st row) will not get exported.

The rowid of a specific item may vary league to league, as the game developers delete entries or add entries in the game file every league.

To be doc:

pypoe_exporter wiki items by_filter

???

Map

All maps after War for the Atlas use the same internal meta data id. It is coded to shuffled easily, so that pypoe use this code to export map

pypoe_exporter wiki items maps map series Expedition --write

Footnotes

item with same name Item with same name can be disambiguated by editing PyPoE/cli/exporter/wiki/parsers/item.py

make sure you checked the naming convention before adding new entry

mediawiki

in wiki, _ cannot be used in the page name, so that it is automatically wrapped to ~.

two underscore , and three and four are parsed differently

Updating the Wiki with a Bot

PyPoE supports exporting to wiki directly.

To do this, you need a bot account to mark all automated edits as performed by a bot so readers can identify and filter out these bulk edits. You should create a new account with a name that have the word bot and the username of the main account, and ask wiki admin to mark it as bot user group.

You can generate bot password in your POE special page BotPasswords. Such as https://www.poewiki.net/wiki/Special:BotPasswords.

You can just select the rights you need, such as high volume edit and then create. Or specify an ip range for more security. Or you can just allow the bot to run in any ip, but after you have used the bot, delete the bot password.

For bot exporting

The command is

pypoe_exporter wiki items item name "Celestial Necrolord Gloves" -w -w-u (username) -w-p (username)@thebotpassword -w-msg helloworld

In which -w (or --wiki ) is exporting to the wiki

-w-u is the username of the bot account in the wiki

-w-p is the place you type password, but in username@password format

-w-msg is the place to specify optional msg in the wiki edit summary, after the automatically filled text . Specify the game version for this update for example (don't type helloworld in the real edit)

There are more command . You can view the hander.py in C:\(you pypoe installation)\cli\exporter\wiki\handler.py

---

Credit @markliu06