Difference between revisions of "Extensions:Species Trait Index"
Tag: 2017 source edit |
(Adding new details as per June 5th 2024's update) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title=Species Trait Index|desc=Provides a visual index of traits associated with a given species.|auth=Mercury|status= | + | {{Extensioninfobox|title=Species Trait Index|desc=Provides a visual index of traits associated with a given species.|auth=Mercury|status=stable|github={{Github|user=itinerare|repo=lorekeeper-ext-archive|branch=species-trait-index}}|migration=no|package=no|modified-main=yes}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
| + | '''This extension is now incorporated into {{Github|user=corowne|branch=modified-main}}.''' The information here is maintained as documentation, and further support is via that branch. | ||
| + | |||
Provides for a visual index of traits associated with a given species. | Provides for a visual index of traits associated with a given species. | ||
| − | The traits are arranged in the style of user inventories-- that is, in their categories if present-- though they are also arranged by rarity (ascending). Images are displayed if present, with a border colour-coded as with the rarity of the trait (if the rarity has an associated colour.) The trait's name is displayed either in addition to the image or alone in the case of no trait image. In the event a trait is associated with a subtype, the associated subtype is also listed. | + | The traits are arranged in the style of user inventories-- that is, in their categories if present-- though they are also arranged by rarity (ascending). Images are displayed if present, with a border colour-coded as with the rarity of the trait (if the rarity has an associated colour.) The trait's name is displayed either in addition to the image or alone in the case of no trait image. Traits without images are listed last within their rarity in an effort to preserve alignment. In the event a trait is associated with a subtype, the associated subtype is also listed. |
This also adds a link to species' trait index to world entries if the species has traits associated with it. | This also adds a link to species' trait index to world entries if the species has traits associated with it. | ||
| Line 11: | Line 13: | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
None necessary. It is worth noting that trait images are capped to 150px height so that the whole page is not overlong in the event that you have many traits associated with a species; you can adjust this in the species_features blade as desired. | None necessary. It is worth noting that trait images are capped to 150px height so that the whole page is not overlong in the event that you have many traits associated with a species; you can adjust this in the species_features blade as desired. | ||
| + | |||
| + | === For the develop branch version, as per June 5th 2024 === | ||
| + | In the <code>config/lorekeeper/extensions.php</code> file, find: | ||
| + | <syntaxhighlight lang="html"> /* Visual Trait Indexes | ||
| + | * | ||
| + | * Species Trait Index - Mercury | ||
| + | * Subtype Trait Index - Speedy | ||
| + | * Universal Trait Index - CHERVB | ||
| + | * Trait Modals addition - Moif | ||
| + | */</syntaxhighlight> | ||
| + | Under <code>'visual_trait_index' =></code> look for the the following options: | ||
| + | |||
| + | <code>'enable_species_index' => 0</code> Set this to 1 to enable the Species Trait Index. It will appear on the Encyclopedia, on the species page, under the name of each species, provided there is a trait exclusive to that species. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| Line 16: | Line 31: | ||
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? --> | <!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? --> | ||
Find me in the Lorekeeper discord! | Find me in the Lorekeeper discord! | ||
| + | == Images == | ||
| + | * [https://www.itinerare.net/gallery/pieces/8.Lorekeeper-Ext-%E2%97%88-Species-Trait-Index?source=projects/pages/lorekeeper&page=1 Writeup with images on my site] | ||
== See Also == | == See Also == | ||
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. --> | <!-- Any relevant other pages. You may consider linking to related extensions, for instance. --> | ||
| + | * [[Updating:_to_2.0.0]] | ||
| + | * [[Updating:_to_3.0.0]] | ||
Latest revision as of 15:54, 5 June 2024
| Description | Provides a visual index of traits associated with a given species. |
|---|---|
| Author(s) | Mercury |
| Status | stable |
| Github | itinerare/lorekeeper-ext-archive/species-trait-index |
| LK Version | Unspecified |
| Is part of LK v2 (modified-main) | |
This extension is now incorporated into modified-main
. The information here is maintained as documentation, and further support is via that branch.
Provides for a visual index of traits associated with a given species. The traits are arranged in the style of user inventories-- that is, in their categories if present-- though they are also arranged by rarity (ascending). Images are displayed if present, with a border colour-coded as with the rarity of the trait (if the rarity has an associated colour.) The trait's name is displayed either in addition to the image or alone in the case of no trait image. Traits without images are listed last within their rarity in an effort to preserve alignment. In the event a trait is associated with a subtype, the associated subtype is also listed.
This also adds a link to species' trait index to world entries if the species has traits associated with it.
Contents
Installation
Pull the branch. No further action necessary.
Configuration
None necessary. It is worth noting that trait images are capped to 150px height so that the whole page is not overlong in the event that you have many traits associated with a species; you can adjust this in the species_features blade as desired.
For the develop branch version, as per June 5th 2024
In the config/lorekeeper/extensions.php file, find:
/* Visual Trait Indexes
*
* Species Trait Index - Mercury
* Subtype Trait Index - Speedy
* Universal Trait Index - CHERVB
* Trait Modals addition - Moif
*/
Under 'visual_trait_index' => look for the the following options:
'enable_species_index' => 0 Set this to 1 to enable the Species Trait Index. It will appear on the Encyclopedia, on the species page, under the name of each species, provided there is a trait exclusive to that species.
Usage
Troubleshooting
Find me in the Lorekeeper discord!
