Dungeon Crawler Carl E-reader Dictionaries

Dungeon Crawler Carl E-reader Dictionaries

This project provides a free custom e-reader dictionary tailored for Dungeon Crawler Carl, allowing users to seamlessly lookup characters, factions, races, spells, achievements, items, and other terms directly from an e-reader dictionary panel. The dictionary entries are sourced from the Dungeon Crawler Carl Wiki with proper permissions, ensuring an accurate and rich reference for fans and readers.

Key Features

• Multiple Output Formats: Generate dictionaries in various formats including Kindle .mobi, StarDict for KOReader and BOOX, and Kobo dicthtml. Each output includes installation notes and build metadata for easy integration.
• Developer-Friendly: This project is designed for developers who wish to customize or extend the functionality. Built using Python 3.11 or newer, it has no package dependencies for core tooling, streamlining the setup process.

Easy Entry Creation

The dictionary creation process involves a straightforward workflow:

1. Fetch Entries: Use the fetch_entries command to crawl specific categories from the fandom wiki and store the results in a SQLite database.
2. Build Output: Create a Kindle dictionary from the entries in the database, allowing for local testing on your devices.
3. Release: Automatically package the generated dictionaries and publish them.

Example commands include:

./bin/fetch_entries --ignore-robots
./bin/build_kindle_dictionary --link-entries --compile
./bin/release --version 0.7.0 --link-entries --publish

Extend to Other Fandoms

While primarily focused on Dungeon Crawler Carl, this project is flexible enough to support other fandoms. Configurations can be tailored to fetch relevant information by adapting the existing JSON config files. For instance, testing with the Ice and Fire fandom is as simple as using specific commands:

./bin/fetch_entries --config examples/iceandfire.json --ignore-robots
./bin/build_kindle_dictionary --config examples/iceandfire.json --link-entries

Important Configuration Details

Configurations are written in standard JSON format and include essential fields such as fandom name, output metadata, and media categories to be fetched. This allows users to customize what is included in their dictionary outputs.

For example:

{
  "fandom": "dungeon-crawler-carl",
  "title": "Dungeon Crawler Carl Dictionary",
  "author": "Generated from Dungeon Crawler Carl Wiki contributors",
  "categories": ["Characters", "Groups", "Spells"]
}

Official Resources

For those interested in simply using the generated dictionaries, a comprehensive download and installation guide is available here, which provides step-by-step instructions for Kindle, Kobo, KOReader, and BOOX users.

This project is an unofficial fan initiative, explicitly approved by the Dungeon Crawler Carl fandom admins, but it operates independently of the official rights holders or publishers.