Difference between revisions of "Extensions:Character Profile Custom Values"

From Lorekeeper Wiki
Jump to navigation Jump to search
(create)
Tag: 2017 source edit
 
(info)
Tag: 2017 source edit
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Character Profile Custom Values|desc=A short description|auth=Pure09/deep-ci|status=release|github={{Github|user=deep-ci|branch=ext-dev/custom-profile-values}}|migration=yes|package=no}}
 
<!-- Put a short summary of your extension here! -->
 
<!-- Put a short summary of your extension here! -->
 +
Lets users add extra fields to their character profiles. Inspired by toyhou.se, and profile display code <s>stolen</s> modified from Uri's organised character features extension! :>
 +
 
== Installation ==
 
== Installation ==
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
 +
This extension is built on the '''develop''' branch. Make sure you are running on develop before installing.
 +
 +
1. Pull the extension.
 +
2. Run <code>php artisan migrate</code>
 +
3. Run <code>php artisan update-extension-tracker</code>
 +
 
== Configuration ==
 
== Configuration ==
 
<!-- Is any configuration necessary? Describe it here! -->
 
<!-- Is any configuration necessary? Describe it here! -->
 +
If you want to alter how this extension appears, you can edit the code directly in the character <code>profile.blade.php</code>
 +
 
== Usage ==
 
== Usage ==
 
<!-- Is there anything users should know about using your extension? -->
 
<!-- Is there anything users should know about using your extension? -->
 +
If values share a group, they will be categorized into the same card. Groups and titles are optional. Values can use HTML.
 +
 +
[[File:Example Character Custom Values Edit Profile.png|thumb|Example of edit profile with custom values installed]]
 +
[[File:Example Character Custom Values Profile.png|thumb|Example of a profile using custom values.]]
 +
 
== 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? -->
 +
 +
May cause conflict with any extensions that alter editing character profiles. Make sure <code>updateCharacterProfile()</code> in <code>Characters/CharacterController.php</code> contains <code>'custom_values_group', 'custom_values_name', 'custom_values_data',</code>.
 +
 +
'''Example''':
 +
<code>if($service->updateCharacterProfile($request->only(['name', 'link', 'custom_values_group', 'custom_values_name', 'custom_values_data', 'text', 'is_gift_art_allowed', 'is_gift_writing_allowed', 'is_trading', 'alert_user']), $this->character, Auth::user(), !$isOwner)) {</code>
 +
 +
Ping @Pure09 on the lorekeeper discord if you need assistance.
 +
 
== 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. -->
 

Revision as of 17:23, 29 March 2021

Character Profile Custom Values
Description A short description
Author(s) Pure09/deep-ci
Status release
Github ext-dev/custom-profile-values
LK Version Unspecified
Contains a Migration






Lets users add extra fields to their character profiles. Inspired by toyhou.se, and profile display code stolen modified from Uri's organised character features extension! :>

Installation

This extension is built on the develop branch. Make sure you are running on develop before installing.

1. Pull the extension. 2. Run php artisan migrate 3. Run php artisan update-extension-tracker

Configuration

If you want to alter how this extension appears, you can edit the code directly in the character profile.blade.php

Usage

If values share a group, they will be categorized into the same card. Groups and titles are optional. Values can use HTML.

Example of edit profile with custom values installed
Example of a profile using custom values.

Troubleshooting

May cause conflict with any extensions that alter editing character profiles. Make sure updateCharacterProfile() in Characters/CharacterController.php contains 'custom_values_group', 'custom_values_name', 'custom_values_data',.

Example: if($service->updateCharacterProfile($request->only(['name', 'link', 'custom_values_group', 'custom_values_name', 'custom_values_data', 'text', 'is_gift_art_allowed', 'is_gift_writing_allowed', 'is_trading', 'alert_user']), $this->character, Auth::user(), !$isOwner)) {

Ping @Pure09 on the lorekeeper discord if you need assistance.

See Also