Beneos Tokens 3.0 - Beneos Module Change Requests

[BeneosBattlemaps]

---

New File Structure

• There will be only one folder for all variants of a token.
  • Completely different tokens will still have their own folders.
• There will no longer be any sub-folders within a token folder (no more */top/* or */iso/*).
• Each token (including all variants) will now have exactly 3 files with new names:
  • *_avatar.webp: The image used for the token in the Actor Explorer.
  • *_token.webp: The image used for the actual token on the Canvas.
  • *_journal.webp: A full-body image that the DM can show to players for visualization.
• The naming structure for each token is as follows and remains consistent:
  • Example: 009-skeleton_henchman-1-token.webp -> ReleaseNumber-Token_Name-VariantNumber-type.FileExtension
  • A file and folder name contains all necessary information separated by a hyphen -.
  • A token name with multiple spaces or hyphens will use underscores _ to separate words, so the hyphen - is only used to separate information in folder and file names.
• In a token folder, there will only be one actor- and one journal- JSON file for all variants of a token. This means during the reading process, individual actor- and journal- JSONs must be generated for each token variant, and the links in these files must be updated to point to the correct avatar, token, and journal webp files.
  • The naming convention for the JSON files is: actor-ReleaseNumber-Token_Name-VariantNumber.json and journal-ReleaseNumber-Token_Name-VariantNumber.json.
  • In the actor-ReleaseNumber-Token_Name-VariantNumber.json, the following paths need to be dynamically adjusted based on the variant:
  • "img": "beneos_assets/beneos_tokens/030-commoner_female/030-commoner_female-1-avatar.webp", (Example)
  • "prototypeToken": {...,"texture": {"src": "beneos_assets/beneos_tokens/030-commoner_female/030-commoner_female-1-token.webp", ...}}
  • And of course, all necessary IDs.
  • In the journal-ReleaseNumber-Token_Name-VariantNumber.json, the following paths need to be dynamically adjusted based on the variant:
  • "src": "beneos_assets/beneos_tokens/030-commoner_female/030-commoner_female-1-journal.webp"
  • The identifier for each token and each variant in the journals is "name". For example, "name": "030_commoner_female_1" would match the journal for 030_commoner_female in variant 1. "name": "030_commoner_female_7" would match the journal for 030_commoner_female in variant 7.
  • And of course, all necessary IDs.

Retained Features

• Content will still be scanned from ...\Data\beneos_assets\beneos_tokens\... and dynamic journal and token compendiums will be built.
  • All features of the reading process, such as the status progress bar, will remain.
• You can still assign a Beneos token to an actor by right-clicking on the actor avatar (this assigns the avatar, token, and journal of the selected "Beneos Token").
• You can still display the journal with the journal image by clicking the button (previously the preview video as webm).
• You can still drag tokens from the search engine into the world.
• The search engine will remain mostly the same, except for some consolidation (see new features).

Removed Features

• The scaling with PLUS and MINUS in the actor context menu is no longer needed, as there is no more scaling (only the core Foundry creature size and the scale factor in the actor token settings).
• Rotating the actor token in the direction of movement is no longer necessary and can be removed.
• The folder 000_module_assets should still be excluded from scanning.

Changed Features

• When a token reaches 0 HP, instead of showing a different webp, the token will now be turned black and white using TokenFX.
• Search Engine: In the future, only variant 1 of a token will be displayed in the search results list, for example, 030-commoner_female-1-token.webp.
  • All other variants of a token will be displayed on mouseover instead of the enlarged token image. These tokens will be shown next to each other and, when wrapping, below each other, large enough to recognize (at least as large as the search result token). Above the variants, the heading "Skin Variants" will be displayed.
  • The changes should look the same in the module as on the beneos-database.com website.

New Features

• Dynamic Token Creation: Since all token variants are grouped together in the same folder, but only the first token (*token_name-1*) has the relevant actor-* and journal-* JSONs, all further actor-* and journal-* JSONs must be dynamically created and stored during the reading process. The goal is to reduce the number of individual files that need to be read from the HDD or server, making it easier for hosting services to build compendiums and significantly shortening load times.

[BeneosBattlemaps]

Download of 4 tokens including their variants and updated jsons (updated version): https://drive.google.com/file/d/1gQ16wbaXR3ud3iACFfo5gSRDr7-tEQ0Z/view?usp=sharing