Difference between revisions of "Config Files"
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | The configuration files are files in the site’s code that allow | + | The configuration files are files in the site’s code that allow customization of certain features that are highly unlikely to be changed on a regular basis. |
=Usage= | =Usage= | ||
These files are located in config/lorekeeper. The following files may be edited to configure an individual site: | These files are located in config/lorekeeper. The following files may be edited to configure an individual site: | ||
| − | * settings.php | + | *settings.php |
| − | * extensions.php | + | *extensions.php |
| − | * sites.php | + | *sites.php |
The others should not be touched except when adding new features. A possible exception may be made for admin_sidebar.php in the event that you are rearranging the sidebar contents. However, please take care in this case to maintain syntax as well as sidebar items. | The others should not be touched except when adding new features. A possible exception may be made for admin_sidebar.php in the event that you are rearranging the sidebar contents. However, please take care in this case to maintain syntax as well as sidebar items. | ||
| Line 21: | Line 21: | ||
Please refer to the comments in the file itself for a complete description of each setting. | Please refer to the comments in the file itself for a complete description of each setting. | ||
| + | |||
| + | ===extensions.php=== | ||
| + | This file lists settings to enable and disable as well as configure certain opt-in extensions integrated into Lorekeeper. For more information, see [[Updating: to 2.0.0]]. | ||
| + | |||
| + | ===sites.php=== | ||
| + | This file lists various sites and values for them and is used to enable/disable available authentication options as well as assist with formatting. For more information, see [[Updating: to 2.0.0]]. | ||
| + | |||
| + | === group_currency_form.php === | ||
| + | This file lists form fields and information for inclusion in the group currency form. For more information, see [[Galleries]]. | ||
| + | |||
| + | ===extension_tracker.php=== | ||
| + | This file lists extensions installed on an individual Lorekeeper site and is used to supply information for the <code>php artisan update-extension-tracker</code> command. It should only be modified by extension authors. For more information, see [[Updating: to 2.0.0]]. | ||
===admin_sidebar.php=== | ===admin_sidebar.php=== | ||
| Line 29: | Line 41: | ||
===item_tags.php=== | ===item_tags.php=== | ||
| − | This file lists item tags that are available to attach to items. Please refer to | + | This file lists item tags that are available to attach to items. Please refer to [[Tutorial: Creating Item Types]] for how to use this file. |
===notifications.php=== | ===notifications.php=== | ||
| Line 43: | Line 55: | ||
*Site Settings | *Site Settings | ||
| + | |||
| + | [[Category:Documentation]] | ||
Latest revision as of 06:56, 24 July 2021
The configuration files are files in the site’s code that allow customization of certain features that are highly unlikely to be changed on a regular basis.
Contents
Usage
These files are located in config/lorekeeper. The following files may be edited to configure an individual site:
- settings.php
- extensions.php
- sites.php
The others should not be touched except when adding new features. A possible exception may be made for admin_sidebar.php in the event that you are rearranging the sidebar contents. However, please take care in this case to maintain syntax as well as sidebar items.
Files
settings.php
This file lists some basic site settings that are unlikely to change once the site is in use, and therefore should be modified before all else. The following properties can be modified here:
- Site Name
- Character Codes (formatting)
- Masterlist Thumbnail Dimensions
- Trade Asset Limit
Please refer to the comments in the file itself for a complete description of each setting.
extensions.php
This file lists settings to enable and disable as well as configure certain opt-in extensions integrated into Lorekeeper. For more information, see Updating: to 2.0.0.
sites.php
This file lists various sites and values for them and is used to enable/disable available authentication options as well as assist with formatting. For more information, see Updating: to 2.0.0.
group_currency_form.php
This file lists form fields and information for inclusion in the group currency form. For more information, see Galleries.
extension_tracker.php
This file lists extensions installed on an individual Lorekeeper site and is used to supply information for the php artisan update-extension-tracker command. It should only be modified by extension authors. For more information, see Updating: to 2.0.0.
admin_sidebar.php
This file lists the links in the admin panel sidebar, as well as the staff power required to view the category of links.
image_files.php
This file lists the files that will appear in the image uploader section of the admin panel.
item_tags.php
This file lists item tags that are available to attach to items. Please refer to Tutorial: Creating Item Types for how to use this file.
notifications.php
This file lists notification types as well as their message texts.
powers.php
This file lists staff powers that can be attached to user ranks.
text_pages.php
This file lists text pages that are generated during setup and cannot be deleted from the admin panel.
See Also
- Site Settings
