Skip to content

Commit

Permalink
* Version 3.5.3
Browse files Browse the repository at this point in the history
New Viewer Features:
- Autocomplete list in filter columns. (Except IE)
- New data columns: Power Type (Attack/Utility), Race Origin.
- Item costs and levels are now filtered by matching any level variations of the item.
- Wildcast in search and filter. (Previously stated in help screen but never implemented.)
- Full text search no longer search individual items in an item set.
- Link back to category list in all entries, in bottom left corner.
- Update checker.

New Downloader Features:
- Quickstart video.
- New formats for data dump: xlsx, csv, tsv, json, and sql (MySQL, SQL Server, Postgre).

Viewer Bug Fix:
- Don't steal focus from on-screen keyboard, detected by comparing screen height before and after search box focus.
- Fix keyboard navigation in Chrome.  Chrome decided not to fix their inconsistent keypress after 7 years.
- Left/Right key no longer cause scrolling.
- Fix reversal of list sort when accessed from url (reload/bookmark).
- Fix focus lost in Edge whenever list is refreshed.
- Fix Type column of Race and Ritual in Everything.
- Fill in missing Chinese translations of columns.
- Fix page title when viewing entry with multi-line title or highlighted title.
- Fix broken links in history section.

Viewer Enhancements:
- Pressing Esc key goes to list page.
- Column filters highlight.
- Scroll to top of list on page flip.
- A notice will popup when no data, linking to project page.
- List title now shows category name.
- New search will flip to first page.
- Quick lookup now excludes the clicked entry, and will not show when not clicked in entry body.
- Heroic/Paragon/Epic (as level) are now sorted into middle of tiers, instead of beginning.
- 0 is now sorted after blanks in numeric fields.
- Revised help and documentations.

Downloader Enhancements:
- Clarified program text.
- Debug toggle now enable/disable extra messages and checks immediately.
- Minor refactor of Converters and major refactor of Exporters.
- Stacktrace now logged for WebView errors.
- Fix correction count by skipping duplicated Arrow of Fate.
- More tag integrity check of entries with more informative message.
- Trim </td> and </tr> during export.
- Simulation mode to test run without active account.  Not user accessible.

Downloader Data Fix:
- Removed 'Attack Technique' from monk powers' title.
- Remove 9 roleplaying (non-game rules) backgrounds from Dra 376.
- Add lookup alias for Athletics, Sustain, Language, Rarity, Pouch, and Cloth.
- Add associated language to background benefit column.
- Manual override the benefit of shifter and 3 other special backgrounds.
- Correct healing surge of hybrid vampire.
- Fix power source columns of multi-source classes.
- Fix sourcebook of essential hybrids.
- Fix cost and level of masterwork, mundane, and a few special equipments.
- Fix cost of Anarusi Codex, Mrtok, and Shivli.
- Fix level of Vecna's Boon of Diabolical Choice.
- Fix type and tier of Sun's Sliver.
- Fill in missing type of racial powers.
- Fill in type of grouped backgrounds.
- Fix class column of spellscarred and theme powers.
- Minor fix of Hamadryad Aspects, Indomitable Resolve, Lurk Unseen, and Spot the Path.
  • Loading branch information
Sheep-y committed Feb 2, 2017
2 parents e1c6e24 + 90d5b39 commit 872b9a4
Show file tree
Hide file tree
Showing 51 changed files with 2,629 additions and 1,326 deletions.
75 changes: 50 additions & 25 deletions README.md
@@ -1,58 +1,83 @@
# 4e Compendium Downloader #

## Version 3.5.2.1 ##
## Version 3.5.3 ##

![Screenshot of program](https://raw.githubusercontent.com/Sheep-y/trpg-dnd-4e-db/master/res/img/History%20-%20v3.5%20viewer.png)
[![3 min. intro video](https://raw.githubusercontent.com/Sheep-y/trpg-dnd-4e-db/development/res/img/Frontpage.jpg)](https://youtu.be/aNDze9Ok5fE)

This app can be used to reterives and locally stores entries from online 4e [D&D Compendium](http://www.wizards.com/dndinsider/compendium/database.aspx).
<br/>
Stored entries can be exported, then browsed and searched with exact phase search, wildcast, exclusion, join ("OR"), and even regular expression.
This app can fetches, stores, and exports D&D 4th edition resources from [D&D Compendium](http://www.wizards.com/dndinsider/compendium/database.aspx). <br/>
Exported entries can be browsed and searched offline with exact phase search, wildcast, exclusion, join ("OR"), and more.

This is a fan-made project and does not come with copyrighted data.
本應用能從四代龍與地下城的[官方資料庫](http://www.wizards.com/dndinsider/compendium/database.aspx)提取、儲存、及匯出資料,以便進行離線的威力搜尋。<br/>
下載器的說明只限英語。匯出資料後會有中文操作說明。

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](http://ddi.wizards.com/) to retrieve data.
1. This may be impossible since registration is closed. See [in-app help](http://htmlpreview.github.io/?https://github.com/Sheep-y/trpg-dnd-4e-db/blob/development/res/downloader_about.html#Troubleshoot) for links.
1. You need an active [Dungeons & Dragons Insider subscription](http://ddi.wizards.com/) to fetch data.
1. This may be impossible since registration is closed. See [in-app help](http://htmlpreview.github.io/?https://github.com/Sheep-y/trpg-dnd-4e-db/blob/development/res/downloader_about.html#faq) for links.
2. [Download](http://www.java.com/) and install Java (version 8 or above).
3. [Download](https://github.com/Sheep-y/trpg-dnd-4e-db/releases/) 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". Note that it is a GUI program.
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 app.
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-app help](http://htmlpreview.github.io/?https://github.com/Sheep-y/trpg-dnd-4e-db/blob/development/res/downloader_about.html) 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 .
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](https://youtu.be/aNDze9Ok5fE) for the above steps.

### Compatibility ###

The downloader is tested with Sun Java version 8 update 121.
If you use [OpenJDK](http://openjdk.java.net/), you also need [OpenJFX](http://openjdk.java.net/projects/openjfx/). <br/>
The viewer is tested on Chrome 56, Edge 14, Firefox 52, IE 11, Android Chrome 56, and Android Firefox 52. <br/>
Mac and iOS cannot be supported. Walled garden is walled.

## Different from Official Compendium ##

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

### Fixing compendium errors ###
* Background: Benefit (Replace Associated Skills).
* Theme: Prerequisite.
* Power: Type (Frequency + Type) and Keyword.
* Feat: Prerequisite.
* Item: Split into 4 categories (Item, Weapon, Implement, and Armor). Add Type column.
* Terrain: Group and Level. Combine with Trap for better mobile layout.

Many existing columns are also enhanced or corrected.

### Fixed errors ###

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

* 152 items missing power frequency. (Dantrag's Bracers, many energy weapons, dragon orbs, light sources etc.)
* The downloader logs 153 fixes. One of them - Arrow of Fate - is a duplicate.
* 79 empty glossaries, removed. (male, female, fang titan drake, etc.)
* 68 entries without "published" record. (Granny's Grief, Dreamheart, Deck of Many Things etc.)
* 150 items missing power frequency. (Dantrag's Bracers, many energy weapons, dragon orbs, light sources etc.)
* 88 empty entries or non-resources, removed. (male, female, fang titan drake, Fastpaw background, etc.)
* 67 entries without "published" record. (Granny's Grief, Dreamheart, Deck of Many Things etc.)
* 60 entries moved to correct category. (Superior implements, Assassin's poisons, and Consumable wondrous)
* 35 entries that wrongly says "basic melee attack". (Bane's Tactics, Feral Armor, Dancing Weapon, Kobold Piker etc.)
* 21 entries with other inconsistent content. (Winged Armor type, Xenda-Dran Array tier, etc.)
* 21 entries with formatting issues. (Mirror of Deception, Silver Hands of Power, etc.)
* 15 entries with missing/wrong content. (Kord's Relentlessness, Rings of the Akarot etc.)
* 4 typos. (Cambion Stalwart "bit points", Fifth Sword of Tyr power keyword, Primal Grove "grp", Rubble Topple "Singe")
* 84 entries with missing/wrong listing data not caused by above issues. (Wild Elf, Enlarge Familiar, some traps etc.)
* 23 entries with formatting issues. (Mirror of Deception, Silver Hands of Power, etc.)
* 20 entries with missing/wrong content. (Kord's Relentlessness, Rings of the Akarot, Hybrid Vampire Surge etc.)
* 10 typos. (Cambion Stalwart "bit points", Primal Grove "grp", Rubble Topple "Singe", Essential hybrid sourcebook etc.)
* 80 entries with other inconsistent content. (Winged Armor type, Xenda-Dran Array tier, Racial power without type etc.)
* 94 entries with missing listing data not caused by above issues. (Subrace abilities, Heroic feat tier etc.)
* 733 entries with wrong/inconsistent listing data not caused by above issues. (Multi-source classes, theme powers etc.)
* In addition, over a hundred artifacts and item sets are manually classified.

If you find similar mistakes that aren't fixed, please [file an issue](https://github.com/Sheep-y/trpg-dnd-4e-db/issues/).

## Source code and building ##
## Developer's Guide ##

* Viewer source code is in html folder.
This app 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.

* The [development branch](https://github.com/Sheep-y/trpg-dnd-4e-db/tree/development) is less vigorously tested but usually have more features and/or fixes.
* Downloader source code is in java folder, and use libraries in java_lib folder.
* Viewer source code is in html folder. It is built with [CocoDoc](https://github.com/Sheep-y/CocoDoc/), also in java_lib.
* Both use resources at the root (license) and in the resource folder.
* Use Ant (build.xml) to 'make' an executable jar. The make_exe target depends on [Launch4j](http://launch4j.sourceforge.net/).
* The jar can also be extracted to a new project folder; use Ant to move the extracted files back to original structure.

The viewer is built with [CocoDoc](https://github.com/Sheep-y/CocoDoc/) app builder, which is bundled and must run in GUI.

[SQLJet](https://sqljet.com/) 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.
Expand Down

0 comments on commit 872b9a4

Please sign in to comment.