Difference between revisions of "Extensions:Free MYOs"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "{{subst:Extension Page}}")
Tag: 2017 source edit
 
(Create Extensions:Free MYOs Page)
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}}|LKVer=What Lorekeeper version the ext is built on|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Free MYOs|desc=Allow users to create free MYOs|auth=AnimatedCritter|status=stable|github={{Github|user=AnimatedCritter|branch=extension/free-myos}}|LKVer=2.0.0|migration=yes|package=no}}
−
<!-- Put a short summary of your extension here! -->
+
An alternative to the slot-box system, this extension was made in an attempt to reduce the amount of menuing required to access free MYO slots, with open/semi-open species in mind!
 +
 
 +
A "Create Free MYO" button is added to the navbar and /characters/myos page, redirecting users to a form and admin-select pool of species/subtypes they can select to create a free MYO slot with. Depending on how the extension is set up, users can create as many MYOs as they'd like!
 
== Installation ==
 
== Installation ==
−
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
Pull and merge the branch, making sure to address any merge issues.
 +
 
 +
Afterwards, run the following commands in your console:
 +
 
 +
<code>php artisan migrate</code>
 +
 
 +
<code>php artisan add-site-settings</code>
 +
 
 +
<code>php artisan update-extension-tracker</code>
 
== Configuration ==
 
== Configuration ==
−
<!-- Is any configuration necessary? Describe it here! -->
+
'''Set species to is_free_myo_usable*:'''
−
== Usage ==
+
 
−
<!-- Is there anything users should know about using your extension? -->
+
'''This is required for setup!''' If no species with this value set to true are found, the creation page will instruct users to submit a bug report, and they will not be able to create free MYOs.
 +
 
 +
To set a species as is_free_myo_usable, go into your admin menu and find your species data. When you click edit (or create) you will find a toggle next to the name field. Turn it on and submit the form. Users will now be able to select that species for their free MYO slot!
 +
 
 +
 
 +
'''Set subtypes to is_free_myo_usable*:'''
 +
 
 +
The same process as species, although subtypes aren't required--even if you have free_myos_require_subtypes enabled in site settings (see below).
 +
 
 +
 
 +
'''Free MYO Slot Name:'''
 +
 
 +
By default, free MYO slots are named, well, "Free MYO". If you'd like to change this, go into resources\views\home\create_free_myo.blade.php, find <code>Form::hidden('name', 'Free MYO')</code> and change <code>'Free MYO'</code> to whatever you prefer (e.g. 'Example MYO').
 +
 
 +
 
 +
'''This extension has seven (7) site settings:'''
 +
 
 +
<code>free_myos_open</code>
 +
* Determines if users can access the free MYO page.
 +
* This only prevents new slots from being created. This does not halt design submissions for pre-exsisting slots.
 +
* Closed by default to allow time for any initial setup while the site is live.*
 +
 
 +
<code>free_myos_max_number</code>
 +
* This sets the limit for how many free MYOs a user can create.
 +
* When set to 0, users can make unlimied MYOs.
 +
* You can always change this setting.
 +
* When users reach this number, they can no longer access the creation form.
 +
* By default, users can create unlimited MYOs.
 +
 
 +
<code>free_myos_rarity</code>
 +
* The ID of the highest rarity a user's free MYO can be.
 +
* Set to 0 to allow for any rarity.
 +
* By default, users aren't bound by any rarity.
 +
 
 +
<code>free_myos_require_subtype</code>
 +
* Requires users to choose a subtype after selecting it's correlating species.
 +
* This only applies if the species has a subtype marked as is_free_myo_usable!
 +
** If a species doesn't have a subtype available, no subtype is applied.
 +
* Disabled by default.
 +
 
 +
<code>free_myos_</code>...
 +
* ...<code>is_tradeable</code>
 +
* ...<code>is_giftable</code>
 +
* ...<code>is_resellable</code>
 +
** Self-explanitory, although resale values will need to be set during the design request approval process.
 +
 
 +
 
 +
<small>*If you plan on changing is_free_myo_usable values while your site is live, I highly suggest temporarily disable free_myos_open in site settings.</small>
 
== Troubleshooting ==
 
== Troubleshooting ==
−
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
If you are having any issues (or have suggestions to improve this extension) you can find me over on the Lorekeeper Discord server (AnimatedCritter#7094)!
 
== Images ==
 
== Images ==
−
<!-- Do you have any images to show what it looks like in action? -->
+
[[File:Screenshot 2022-10-06 214731.png|thumb]][[File:Screenshot 2022-10-06 214822.png|thumb]]
−
== See Also ==
 
−
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
−
 
 

Revision as of 07:40, 8 October 2022

Free MYOs
Description Allow users to create free MYOs
Author(s) AnimatedCritter
Status stable
Github extension/free-myos
LK Version 2.0.0
Contains a Migration






An alternative to the slot-box system, this extension was made in an attempt to reduce the amount of menuing required to access free MYO slots, with open/semi-open species in mind!

A "Create Free MYO" button is added to the navbar and /characters/myos page, redirecting users to a form and admin-select pool of species/subtypes they can select to create a free MYO slot with. Depending on how the extension is set up, users can create as many MYOs as they'd like!

Installation

Pull and merge the branch, making sure to address any merge issues.

Afterwards, run the following commands in your console:

php artisan migrate

php artisan add-site-settings

php artisan update-extension-tracker

Configuration

Set species to is_free_myo_usable*:

This is required for setup! If no species with this value set to true are found, the creation page will instruct users to submit a bug report, and they will not be able to create free MYOs.

To set a species as is_free_myo_usable, go into your admin menu and find your species data. When you click edit (or create) you will find a toggle next to the name field. Turn it on and submit the form. Users will now be able to select that species for their free MYO slot!


Set subtypes to is_free_myo_usable*:

The same process as species, although subtypes aren't required--even if you have free_myos_require_subtypes enabled in site settings (see below).


Free MYO Slot Name:

By default, free MYO slots are named, well, "Free MYO". If you'd like to change this, go into resources\views\home\create_free_myo.blade.php, find Form::hidden('name', 'Free MYO') and change 'Free MYO' to whatever you prefer (e.g. 'Example MYO').


This extension has seven (7) site settings:

free_myos_open

  • Determines if users can access the free MYO page.
  • This only prevents new slots from being created. This does not halt design submissions for pre-exsisting slots.
  • Closed by default to allow time for any initial setup while the site is live.*

free_myos_max_number

  • This sets the limit for how many free MYOs a user can create.
  • When set to 0, users can make unlimied MYOs.
  • You can always change this setting.
  • When users reach this number, they can no longer access the creation form.
  • By default, users can create unlimited MYOs.

free_myos_rarity

  • The ID of the highest rarity a user's free MYO can be.
  • Set to 0 to allow for any rarity.
  • By default, users aren't bound by any rarity.

free_myos_require_subtype

  • Requires users to choose a subtype after selecting it's correlating species.
  • This only applies if the species has a subtype marked as is_free_myo_usable!
    • If a species doesn't have a subtype available, no subtype is applied.
  • Disabled by default.

free_myos_...

  • ...is_tradeable
  • ...is_giftable
  • ...is_resellable
    • Self-explanitory, although resale values will need to be set during the design request approval process.


*If you plan on changing is_free_myo_usable values while your site is live, I highly suggest temporarily disable free_myos_open in site settings.

Troubleshooting

If you are having any issues (or have suggestions to improve this extension) you can find me over on the Lorekeeper Discord server (AnimatedCritter#7094)!

Images

Screenshot 2022-10-06 214731.png
Screenshot 2022-10-06 214822.png
Retrieved from "http://wiki.lorekeeper.me/index.php?title=Extensions:Free_MYOs&oldid=1625"