NetHackWiki:Download

From NetHackWiki
Jump to navigation Jump to search

You can download the NetHackWiki (right click on each, select "Save Link As"):


Some readers

You can install mediawiki locally, but it's quite a bother. You can also use the dump directly with a reader.

  • xowa (multiplatform)

Currently, what you need to do, in order to setup xowa to use NetHackWiki.

You download the dumps. You import it, the name of the folder the dump is in, will be used as the name for the wiki. Don't test it after you import it, because by default, it will try to use the commons of wikipedia.

To setup the images go in "home/wiki/Help:Options/Config_script" And add a script like this (with your paths and your wikiname) app.wikis.get('WikiName').files.wkrs.get('fs.dir') { orig_dir = '~{<>xowa_root_dir<>}/wiki/WikiName/images/'; thumb_dir = '~{<>xowa_root_dir<>}/wiki/WikiName/images/thumb/'; }

Restart, and it should work as expected. If you have problems ask for help in the forum.

The tty maps will not work however, because NetHackWiki uses a custom plug in for these.

Zim Archive

Zim archives are a self-contained copy of the wiki which can be read via an application like Kiwix These are generated and hosted by a user: Parted. If there is an issue, ping them on IRC

--Parted (talk) 23:06, 4 May 2025 (UTC)


Alternative zim archives handcrafted by rengaf (reachable on Roguelikes discord):

--Rengaf (talk) 13:00, 17 July 2025 (UTC)


Local Container Instance

Runs a local mirror in Docker. This wiki runs MediaWiki 1.43.

sudo mkdir -p /opt/nethackwiki-dumps /opt/nethackwiki-mirror
cd /opt/nethackwiki-dumps
wget https://archive.alt.org/nethackwiki/nethackwiki_current.xml.gz
wget https://archive.alt.org/nethackwiki/nethackwiki_current_images.tar.gz
gunzip nethackwiki_current.xml.gz
tar -xzf nethackwiki_current_images.tar.gz

docker run -d --name nethackwiki -p 8080:80 \
  -v /opt/nethackwiki-dumps:/var/www/html/dumps:ro \
  -v /opt/nethackwiki-mirror:/var/www/html/data \
  mediawiki:1.43

Open http://localhost:8080 and run the installer; SQLite is enough for a read-only mirror. Then:

docker exec -it nethackwiki bash
cd /var/www/html
php maintenance/importDump.php dumps/nethackwiki_current.xml
cp -r dumps/images/* data/images/
chown -R www-data:www-data data/images/
php maintenance/rebuildall.php
php maintenance/initSiteStats.php

Extensions a mirror will not have

These are written for NetHackWiki, have no upstream, and are not publicly distributed. Nothing in the Docker image provides them, so pages using them will not render as they do here. Page counts are from the current dump.

  • ReplaceCharsBlock<replacecharsblock>. Renders the tty dungeon maps. 262 pages.
  • MixedSyntaxHighlight__MIXEDSYNTAXHIGHLIGHT__. 627 pages.
  • SimpleTabs<simpletabs>. Tabbed content blocks. 66 pages.
  • RandomPageTitle{{#rndpagetitle:}}. 5 pages.

Also not in the image, but installable from mediawiki.org: CharInsert, DPLforum, Editcount, LabeledSectionTransclusion, TitleKey.