Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.25 KB

How to Add YOUR Extensions.md

File metadata and controls

38 lines (29 loc) · 2.25 KB

How to add YOUR Extension to SharkPool's Extension Collection

Step-By-Step Tutorial

Step 1: Make Your Extension

  • Rule 1: Please Follow Normal Extension JS Format, extensions made with Turbobuilder or anything alike are Not Allowed

Step 2: Make a Thumbnail for Your Extension

  • Rule 1: It MUST be 300x150px SVG (without Border)
  • Rule 2: It MUST have a curved outline bordering the thumbnail (Copy the Borders used in Existing Thumbnails)

Step 3: Add your Extension Code and Thumbnail to the 'extension-code' and 'extension-thumbs' folders on Github

Step 4: Edit and Add to the Extension Keys JSON

  • Rule 1: Under the 'extensions' key, you need to add a new sub-key right before the 'example' extension
  • Rule 2: Format it like this, replace the [text] with your links/text:
    "[Extension-Name]": {
       "credits": "[A Short Description of your Extension with Credits]",
       "url": "[Link to the RAW GITHUB FILE for your Extension Code]",
       "tags": "[Tags that Relate to your Extension]"
       "status": "[use 'new' if its a new extension or 'update' if its an update to an existing extension]"
    }
    

(If you cant link the raw file then SharkPool will do it for you)

  • Sub Rule 1: Extension Name MUST NOT include spaces, use '-' instead
  • Sub Rule 2: Tags MUST start with '.all'
  • Sub Rule 3: Tags MUST be split by '.' and MUST be from this list:
    • 'utilities' --> Utility Blocks
    • 'expanded' --> Expansion of an existing Custom/Vanilla Extension
    • 'category' --> Expansion of an existing Main/Sub Category (Motion, Looks, Control, etc)
    • 'fetching' --> Extensions that use 'fetch' or anything related to it

Note: Dont worry about the Extension Thumbnail as they are Automatically Loaded

Step 5: Pull Request and You're Done!

Note: Remember to include all files and changes (SVG Thumbnail, Extension Code, and JSON additions: RAW Code Link, Credits, Name, Tags))