Sheep-y / trpg-dnd-4e-db

4e Compendium - Offline D&D 4e Database
Other
57 stars 7 forks source link
database dungeons-and-dragons gaming html5 java java-8 javafx javascript offline sqljet tabletop-rpgs

4e Compendium Downloader

Version 3.6.1

3 min. intro video

This program can fetches, stores, and exports D&D 4th edition resources from D&D Compendium.
Exported entries can be browsed and searched offline with exact phase search, wildcast, exclusion, join ("OR"), and more.

本應用能從四代龍與地下城的官方資料庫提取、儲存、及匯出資料,以便進行離線的威力搜尋。
下載器的說明只限英語。匯出資料後的搜尋介面可以在說明頁中切換成中文。 注意 3.x 為最後一代有中文介面的數據庫。日後的版本只支援英文。

This is a fan project and does not come with copyrighted data.

How To Download Data

  1. You need an active Dungeons & Dragons Insider subscription to fetch data.
    1. A new subscription can be purchased from digitalriver.
  2. Download and install Java (version 8 or above).
  3. Download the downloader exe (Windows) or downloader jar (Linux/Mac).
  4. Open a folder for the downloader, put it in, and run it.
    1. Jar version: If double clicking the jar file does not work, open console and run "java -jar 4e_compendium_downloader.jar". This should launch the program.
  5. In the downloader, fill in DDI username and password, then click "Download".
    1. Download can be stopped and resumed any time.
    2. See in-program help for steps and troubleshoots.
  6. Once all data is downloaded, you can export the data to an HTML file, which can be opened in browsers.
  7. There is a video guide for the above steps.

Compatibility

The downloader is tested with Sun Java 8 and 9. If you use OpenJDK, you also need OpenJFX.
The viewer is tested on Chrome 63, Edge 15, Firefox 57, IE 11, Android Chrome 63, Android Firefox 57, and Android UC Browser 11.5.
Mac and iOS cannot be supported. Walled garden is walled.

Differences from Official Compendium

This downloader will create new data columns for easier data filter:

Many existing columns are also enhanced or corrected, such as multi-source classes.

Fixed errors

Let's face it, the official compendium has errors. This downloader fixes over 1560 entries during export:

If you find similar mistakes that aren't fixed, please file an issue.

Developer's Guide

This program has two parts: a downloader that fetch and export data, and a viewer that browse exported data. The downloader will embed the viewer on build, so that there is only one deployable file.

SQLJet is used to access sqlite database, but the data cannot be read by other SQLite libraries. It may be a sqljet issue. Since it is very light and has no other issues, I'm keeping it and hoping someone can find what's wrong someday.

Code, documentations, and related resources are open source and licensed under GNU AGPL v3.
D&D and Dungeons & Dragons are trademarks of Wizards of the Coast LLC.