Skip to main content

Website on VTES Strategy, cards rulings and TWD search interface

Project description

Codex of the Damned

PyPI version Validation Python version License Code Style

This site is a compilation of Vampire: the Eternal Struggle strategy resources. The site is publicly available at codex-of-the-damned.org.

Portions of the materials are the copyrights and trademarks of Paradox Interactive AB, and are used with permission. All rights reserved. For more information please visit www.worldofdarkness.com.

Dark Pack

Contributing

Contributions are welcome. Pull Requests will be merged if they respect the general style. Issues will be dealt with as quickly as possible.

This site uses Flask and Babel to generate pages dynamically and handle internationalisation.

Installation

To install a working developpment version of the site, use pip:

python3 -m venv venv
pip install -e ".[dev]"

Translating

Install a PO editor like POEdit, call the following command to generate the messages in the language you're interested in:

BABEL_LANG=es make po-update

Then open the generated catalog file, codex_of_the_damned/translations/es/LC_MESSAGES/messages.po, in your PO editor.

While translating, beware to keep the HTML tags like <p>, <em> as they are, and make sure you keep the exact same format parameters in the translated text. They include anything dynamic, from disciplines like %(cel)s and clans like %(brujah)s, to cards like %(alastor)s and external urls like %(johns_deck).

Once you're done translating, generate the translation files with:

make po

To make a new language accessible in the website, you simply have to add the matching line in the translation nav header of the global layout codex_of_the_damned/templates/layout.html:

<nav role="translation">
    {{ translation('en', "🇬🇧") }}
    {{ translation('fr', "🇫🇷") }}
</nav>

Run a dev server

You can run the development version of the site using the codex entrypoint:

$ codex
 * Serving Flask app "codex_of_the_damned" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

You can set the DEBUG environment variable to activate the debug mode:

DEBUG=1 codex

Production deployment

To run the production server, you'll need a web server like uWSGI:

uwsgi --module codex_of_the_damned:app

or Gunicorn:

gunicorn codex_of_the_damned:app

Useful tools

Icons

Convert icons from raster to SVG using imagemagick and potrace, depending on the icon, smoothing may be better or not:

convert -morphology Smooth Octagon:2 clan-ahrimanes.gif clan-ahrimanes.svg

Google Translate

Use POEdit and Google Translate to help with translations.

Run make po to build the translation files under codex-of-the-damned/translations, edit them with POEdit, then run make po when you're done to streamline them.

Project details


Release history Release notifications | RSS feed

This version

1.76

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_of_the_damned-1.76.tar.gz (22.7 MB view details)

Uploaded Source

Built Distribution

codex_of_the_damned-1.76-py3-none-any.whl (22.8 MB view details)

Uploaded Python 3

File details

Details for the file codex_of_the_damned-1.76.tar.gz.

File metadata

  • Download URL: codex_of_the_damned-1.76.tar.gz
  • Upload date:
  • Size: 22.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for codex_of_the_damned-1.76.tar.gz
Algorithm Hash digest
SHA256 2641ae993abed77bc16cecb0629931c9c4b3d9c01b7635df64bfb230a732751c
MD5 782463f110de1ecba367c76cbb8de242
BLAKE2b-256 c5f84d8008653685b2aec92bb728a4fdd4fbc2c4e43fa27650748fe401aac52e

See more details on using hashes here.

File details

Details for the file codex_of_the_damned-1.76-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_of_the_damned-1.76-py3-none-any.whl
Algorithm Hash digest
SHA256 013dbdd3ad9a6f5d6626afddec03bdc1d7091306546648f497fe826989fa396f
MD5 c4743f15a5d2cf1c5ac0d84782ed27d8
BLAKE2b-256 3054aeb8658c76325ead922bd9e75bc35b1636879a290f70d82af4917a9f6778

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page