Extensions:Galleries
| Description | Provides a space for users to upload art and writing. |
|---|---|
| Author(s) | Mercury |
| Status | Testing |
| Github | galleries |
| LK Version | Unspecified |
| Contains a Migration | |
| Uses a Package | |
WIP WIP WIP WIP
Contents
just so many features
Installation
See Tutorial: Installing Extensions for general information on how to install extensions. The following is required for galleries specifically:
- Pull the branch.
- Install the associated package using this method:
| Installing packages with Composer: |
Commands are given as composer [command]; if you have not installed composer globally, they will be php composer.phar [command] instead.
|
You may need to run composer self-update (assuming you have not recently) before installing package(s). If possible, update to composer v2.x; you may need to use the command composer self-update --2.
|
If feasible, run composer update.
|
If you encounter memory issues: Locally, run composer update. Copy the composer.lock file to your site's server.
|
Run composer install.
|
- Run
php artisan migrate. - Run
php artisan add-gallery-settings.
Configuration
Basic Configuration
Adjust the added settings in the site settings admin panel. These are as follows:
- gallery_submissions_open
- gallery_submissions_require_approval
- gallery_submissions_reward_currency
You may want to close gallery submissions globally while you are performing basic set up of galleries.
Create galleries in the data/galleries admin panel, adjusting settings per gallery as desired.
Currency Form Configuration
Only necessary if gallery_submissions_reward_currency is ENABLED.
If necessary, set the group_currency site setting (in the site settings admin panel) to the ID of the currency you wish to award to users for gallery submissions. By default, it is set to 1.
This module will work out of the box but will not be customized to your game, so you should configure it as appropriate.
The form itself is configured in config/lorekeeper/group_currency_form.php. This config file is commented extensively in an endeavor to make it easy to customize.
The function responsible for calculating a total based on users' form input is at the top of app/Helpers/AssetHelpers. This is unfortunately more or less hard-coded; however, it is also commented extensively. Note that the fields used in this formula must be the same as the ones within the form, or it will break and/or not calculate the total properly.
Usage
Submit art and/or writing to galleries by clicking the "submit" button in the index or on the gallery's page.
Troubleshooting
There is a known issue that arises when viewing a page with currency-related information with no currencies created, or with the group_currency site setting set to the ID of a currency that does not/no longer exists. This can be solved by creating a currency or setting the site setting to the ID of a currently extant currency.
For other issues, I can be found in the Lorekeeper discord.
