Difference between revisions of "Extensions:Selected Character"
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
m (Added screenshots) Tag: 2017 source edit |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{Extensioninfobox|title=Selected Character|desc=Allows users to select one of their characters for display.|auth=Mercury|status=Testing|github={{Github|user=itinerare|branch=extension/selected-character}}|LKVer=2.0.0|migration=yes|package=no}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
| + | Allows users to pick a "selected"/active character via the My Characters (/characters) page, which will then be displayed on their profile in lieu of the standard character listing. (The latter code is retained, but commented out.) The selected character display is implemented as a widget, and so can be placed elsewhere around the site at will via @include, e.g. <code>@include('widgets._selected_character', ['character' => Auth::user()->settings->selectedCharacter, 'user' => Auth::user(), 'fullImage' => true])</code> to refer explicitly to the currently logged-in user (for instance on the user dashboard). | ||
== Installation == | == Installation == | ||
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | <!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | ||
| + | Pull the branch; run <code>php artisan migrate</code> and <code>php artisan update-extension-tracker</code>. | ||
== Configuration == | == Configuration == | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | The widget as present on the user profile is set to show the character's full image versus the thumbnail. If the thumbnail is preferred, set the "fullImage" variable to false. Likewise for anywhere else you opt to put the widget. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| + | Users can select a character via the My Characters page. | ||
| + | == Images == | ||
| + | <gallery> | ||
| + | File:Character not selected.png|alt=A Lorekeeper user profile without a selected character. The selected character box contains the text "You have no selected character..."|A user profile when a character is not yet selected. | ||
| + | File:Select a character.png|alt=The My Characters Lorekeeper page showing a dropdown menu beneath the user's characters where they can select a character.|The My Characters page showing the dropdown in which a user can select a character. | ||
| + | File:Character selected.png|alt=A Lorekeeper user profile with a selected character. The selected character box shows a thumbnail of character OFF-001.|A user profile showing a selected character (in thumbnail mode). | ||
| + | </gallery> | ||
== Troubleshooting == | == Troubleshooting == | ||
<!-- 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 server! | ||
== Images == | == Images == | ||
<!-- Do you have any images to show what it looks like in action? --> | <!-- Do you have any images to show what it looks like in action? --> | ||
== 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. --> | ||
| − | |||
Latest revision as of 13:28, 9 May 2022
| Description | Allows users to select one of their characters for display. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | extension/selected-character |
| LK Version | 2.0.0 |
| Contains a Migration | |
Allows users to pick a "selected"/active character via the My Characters (/characters) page, which will then be displayed on their profile in lieu of the standard character listing. (The latter code is retained, but commented out.) The selected character display is implemented as a widget, and so can be placed elsewhere around the site at will via @include, e.g. @include('widgets._selected_character', ['character' => Auth::user()->settings->selectedCharacter, 'user' => Auth::user(), 'fullImage' => true]) to refer explicitly to the currently logged-in user (for instance on the user dashboard).
Installation
Pull the branch; run php artisan migrate and php artisan update-extension-tracker.
Configuration
The widget as present on the user profile is set to show the character's full image versus the thumbnail. If the thumbnail is preferred, set the "fullImage" variable to false. Likewise for anywhere else you opt to put the widget.
Usage
Users can select a character via the My Characters page.
Images
A user profile when a character is not yet selected.
The My Characters page showing the dropdown in which a user can select a character.
A user profile showing a selected character (in thumbnail mode).
Troubleshooting
Find me in the Lorekeeper server!
