NetHackWiki:Download

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

• XML dump of current pages (~39 MiB gz)
• XML dump of full page histories (41 MiB xz)
• images (~192 MiB gz)

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.

• WikiTaxi (Windows only)

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

• nethackwiki_en_all_2025-01.zim (~23 MB)

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

Local Container Instance

You can run NetHackWiki locally using Docker with MediaWiki. This provides a full-featured local instance that you can browse with your web browser.

Prerequisites

• docker cli (shouldn't be sensitive to exact one) installed on your system
• Several GB of available disk space (in /opt for this example)

Quick Setup

1. **Create the working directories:**

   sudo mkdir -p /opt/nethackwiki-dumps
   sudo mkdir -p /opt/nethackwiki-mirror
   cd /opt/nethackwiki-dumps
   

2. **Download the NetHackWiki content:**

   # Download the XML dump
   wget https://s3.amazonaws.com/altorg/nethackwiki/nethackwiki_current.xml.gz
   
   # Download the images (optional, but recommended for full experience)
   wget https://s3.amazonaws.com/altorg/nethackwiki/nethackwiki_current_images.tar.gz
   
   # Extract the XML dump
   gunzip nethackwiki_current.xml.gz
   
   # Extract images if downloaded
   tar -xzf nethackwiki_current_images.tar.gz
   

3. **Run MediaWiki with Docker:**

   # Start MediaWiki container
   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 \
     -e MEDIAWIKI_DB_TYPE=sqlite \
     -e MEDIAWIKI_DB_NAME=nethackwiki \
     mediawiki:1.39
   

4. **Access the setup:**

  * Open your browser and go to `http://localhost:8080`
  * Follow the MediaWiki installation wizard
  * Choose SQLite as the database type for simplicity
  * Complete the basic setup

5. **Import the NetHackWiki content:**

   # Access the container shell
   docker exec -it nethackwiki bash
   
   # Navigate to MediaWiki directory
   cd /var/www/html
   
   # Import the XML dump
   php maintenance/importDump.php /var/www/html/dumps/nethackwiki_current.xml
   
   # Rebuild the search index
   php maintenance/rebuildall.php
   
   # Update article counts and statistics
   php maintenance/initSiteStats.php
   

6. **Copy images (if downloaded):**

   # Still in the container shell
   cp -r /var/www/html/dumps/images/* /var/www/html/data/images/
   
   # Fix permissions
   chown -R www-data:www-data /var/www/html/data/images/
   

7. **Exit container shell and restart:**

   exit
   docker restart nethackwiki
   

Usage

• Access your local NetHackWiki at `http://localhost:8080`
• The wiki will be fully searchable and browsable
• All internal links should work correctly
• Images will display if you downloaded and imported them

Management

• **Stop the container:** `docker stop nethackwiki`
• **Start the container:** `docker start nethackwiki`
• **View logs:** `docker logs nethackwiki`
• **Remove completely:** `docker rm -f nethackwiki` (data in /opt/nethackwiki-dumps and /opt/nethackwiki-mirror will remain)

Notes

• This setup uses SQLite for simplicity, which is suitable for local read-only use
• There are several plugins which might make some pages weird. Is what it is for now.