Firefish Snippets Collection

A small but growing collection of AiScript plugins that have been vetted for use on Firefish instances. Submit yours for review and inclusion.

Some snippets require specific versions of Firefish to work. Please check the snippet's description for more information.
New to Firefish Plugins? Learn how to install them. Still unsure? Get the details of how they work.

MFM Snippet: Mini Scotland

Artist: @MariaTheMartian Firefish 1.0

MFM Snippet: Space Kittens

Artist: @Kiko Firefish 1.0

MFM Snippet: Around the World

Artist: @Kiko Firefish 1.0

MFM Snippet: Disco Beats

Artist: @jovikowi Firefish 1.0

MFM Snippet: Pac Pride

Artist: @jovikowi Firefish 1.0

MFM: Ocean Life

Artist: @MariaTheMartian Firefish 1.0

For Followers Only

Detail: Creates a visual indicator that a note is intended for followers only.
Creator: @box464 Firefish 1.0+

List My Pages

Detail: View a list of your Firefish Pages urls.
Creator: @box464 Firefish 1.0+

Timeline Highlighter

Detail: Highlight phrases in your timeline.
Creator: @box464 Firefish 1.0+

Share to Mastodon

Detail: Share a Firefish note to Mastodon.
Creator: @box464 Firefish 1.0+

Lister

Detail: Add the author of a note to a list.
Creator: @box464 Firefish 1.0+

Post Template

Detail: Paste a text / MFM template into your posts.
Creator: @box464 Firefish 1.0+

Display User Id

Detail: From a user profile, display the Firefish User Id.
Creator: @box464 Firefish 1.0+

Your Plugin

Created your own plugin?
Submit for review and inclusion here! Firefish

/// @ 0.11.1
  ### {
    name: "Snippets: Mini Scotland"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Mini Scotland'"
        default: "Mini Scotland"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@MariaTheMartian@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "$[x4 🌄] $[scale.x=3 $[scale.y=3 $[rainbow $[flip $[position.x=2.1 🦄]]]]] $[x2 $[position.x=-2.3 $[position.y=0.45 🌷]]] $[x2 $[position.x=-4 $[position.y=-2 ☁️]]] $[x2 $[position.x=-7 $[position.y=-1.5 ☁️]]]"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

#c = {}
  c.debug <- Plugin:config.debug
  c.snippetTitle <- Plugin:config.snippetTitle
  c.snippetContent <- Plugin:config.snippetContent
  c.blankCanvas <- Plugin:config.blankCanvas
  c.snippetAuthorName <- "@MariaTheMartian@calckey.social"

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

// Add Snippet Author 
    ? (c.snippetAuthorName != _) {
      ? (Str:len(c.snippetAuthorName) > 0) {
        _snippetContent <- Arr:join([_snippetContent Str:lf "$[sparkle **Snippet by:** " c.snippetAuthorName "]"])
      }
    }
      postFormText <- Arr:join([postFormText _snippetContent])

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
  ### {
    name: "Snippets: Space Kittens"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Space Kittens'"
        default: "Space Kittens"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@kiko@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "<center>::lf::$[scale.x=1.06 $[position.y=5 $[scale.x=5,y=5  $[bg.color=113 :blank:]]]]::lf::$[position.x=6,y=1 $[scale.x=0.3,y=0.3 $[fade.speed=0.6s $[fade.speed=2.3s $[fade.speed=0.4s 🌟]]]]] $[position.x=-2.5,y=-1.5 $[scale.x=0.25,y=0.25 $[fade.speed=1s $[fade.speed=2.5s $[fade.speed=0.43s 🌟]]]]] $[position.x=-1,y=2 $[scale.x=0.3,y=0.3 $[fade.speed=1.9s $[fade.speed=0.7s $[fade.speed=0.4s 🌟]]]]] $[position.x=0,y=-1.6 $[scale.x=0.25,y=0.25 $[fade.speed=1.7s $[fade.speed=2.5s $[fade.speed=0.8s 🌟]]]]] $[position.x=0.7,y=-1.9 $[scale.x=0.35,y=0.35 $[fade.speed=1.6s $[fade.speed=2.5s $[fade.speed=1.76s 🌟]]]]] $[position.x=2,y=1 $[scale.x=0.25,y=0.25 $[fade.speed=1.3s $[fade.speed=0.5s $[fade.speed=0.9s 🌟]]]]]]::lf::$[position.x=-3,y=2 $[scale.x=0.35,y=0.35 $[fade.speed=1.3s $[fade.speed=1.5s $[fade.speed=1.9s 🌟]]]]]]$[position.x=5,y=2.1 $[scale.x=0.4,y=0.4 $[fade.speed=1.3s $[fade.speed=2.5s $[fade.speed=0.78s 🌟]]]]]]$[position.x=-1,y=-0.5 $[scale.x=0.15,y=0.15 $[fade.speed=1.3s $[fade.speed=3.5s $[fade.speed=1.2s 🌟]]]]]]::lf::$[fade $[position.y=-1,x=5 $[spin.speed=4s $[scale.x=2,y=2   🍕]]]]$[fade.speed=2s $[position.y=3,x=1 $[spin.speed=3s $[scale.x=2,y=2       🍕]]]]$[fade.speed=1.3s $[position.y=-2,x=-4 $[spin.speed=2.3s $[scale.x=2,y=2     🍕]]]]::lf::$[flip $[position.x=-3,y=2 $[scale.x=0.35,y=0.35 $[fade.speed=1.3s $[fade.speed=1.5s $[fade.speed=1.9s 🌟]]]]]]$[position.x=5,y=2.1 $[scale.x=0.4,y=0.4 $[fade.speed=1.3s $[fade.speed=2.5s $[fade.speed=0.78s 🌟]]]]]]$[position.x=-1,y=-0.5 $[scale.x=0.15,y=0.15 $[fade.speed=1.3s $[fade.speed=3.5s $[fade.speed=1.2s 🌟]]]]]]]::lf::$[position.y=-7,x=0.5 $[x3 🐱]]::lf::$[position.y=3 $[blur $[rainbow $[position.x=-3.7,y=-9 $[rotate.deg=-52 $[scale.x=3.5,y=1 $[scale.x=3.4,y=1 $[rotate.deg=86 🔺]]]]]::lf::$[flip $[position.x=-5,y=-10.55 $[rotate.deg=-52 $[scale.x=3.5,y=1 $[scale.x=3.5,y=1 $[rotate.deg=86 🔺]]]]]]]]::lf::$[position.y=-3 $[rainbow $[position.x=-3.7,y=-9 $[rotate.deg=-52 $[scale.x=3.5,y=1 $[scale.x=3.4,y=1 $[rotate.deg=86 🔺]]]]]::lf::$[flip $[position.x=-5,y=-10.5 $[rotate.deg=-52 $[scale.x=3.5,y=1 $[scale.x=3.5,y=1 $[rotate.deg=86 🔺]]]]]]]]]::lf::$[position.y=-16.4,x=0.5 $[scale.x=1.2,y=1.2 $[fg.color=000 ⚫-⚫]]]::lf::::lf::</center>"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
  ### {
    name: "Snippets: Around the World"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Around the World'"
        default: "Around the World"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@kiko@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "$[spin.speed=7s $[rotate.deg=-90 $[flip $[jump.speed=3s $[position.x=-2,y=2      🐬]]]]$[x4 $[rotate.dev=90 🌍]]$[rotate.deg=120 $[position.y=1,x=1 🌴]$[position.y=1,x=1 🌳]]]"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
  ### {
    name: "Snippets: Disco Beats"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Disco Beats'"
        default: "Disco Beats"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@jovikowi@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "<center>::lf::$[position.x=-2.8,y=4  $[rainbow $[x4 $[blur $[scale.x=2 $[position.x=.25 ⬛️ ]]]]]$[x2 $[position.x=-3,y=-1 🌃 ]] $[x2 $[position.x=-4,y=-2 $[rainbow 🪩]]] $[x2 $[position.x=-3,y=.5 🪴]]]::lf::</center>::lf::<center>::lf::$[x2 🪑$[position.x=-1.2,y=-0.49 🧘‍♀️] $[position.x=-2.7,y=-.9 $[scale.x=0.6,y=0.6 $[shake.speed=5s 🐱]]] $[position.x=-3 🪑$[position.x=-1.2,y=-0.49 🧘‍♀️] $[position.x=-2.73,y=-.89 $[scale.x=0.8,y=0.8 $[shake.speed=6s 🐺]]]]]::lf::</center>::lf::<center>::lf::$[position.y=-11,x=5 $[shake.speed=2s 🎵] $[shake.speed=3s 🎶]]$[x3 $[position.y=-1.2,x=-1.4  $[scale.x=.3,y=.4 $[position.x=1.5,y=.5 🛢️]]$[scale.y=0.4 $[position.x=-.8 $[rainbow 🧫 ]]]]]::lf::</center>"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
  ### {
    name: "Snippets: Pac Pride"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Pac Pride'"
        default: "Pac Pride"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@jovikowi@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "$[rainbow.speed=6s $[fg.color=fff $[font.monospace $[position.x=10 $[scale.x=2,y=4 LET YOUR PAC-PRIDE FLY!]]::lf::$[scale.x=6,y=1 $[position.x=0,y=2 $[scale.x=6,y=2  $[bg.color=e22 :blank:]]]]BLINKY::lf::$[scale.x=6,y=1 $[position.x=0,y=4 $[scale.x=6,y=2  $[bg.color=f82 :blank:]]]]CLYDE::lf::$[scale.x=6,y=1 $[position.x=0,y=6 $[scale.x=6,y=2  $[bg.color=fe0 :blank:]]]]KINKY::lf::$[scale.x=6,y=1 $[position.x=0,y=8 $[scale.x=6,y=2  $[bg.color=260 :blank:]]]]FUNKY::lf::$[scale.x=6,y=1 $[position.x=0,y=10 $[scale.x=6,y=2  $[bg.color=7dd :blank:]]]]INKY::lf::$[scale.x=6,y=1 $[position.x=0,y=12 $[scale.x=6,y=2  $[bg.color=939 :blank:]]]]SUE::lf::]::lf::$[font.monospace :blank:::lf::$[position.x=3,y=-15.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  BLINKY]]::lf::$[position.x=2.9,y=-12.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  CLYDE]]::lf::$[position.x=2.8,y=-9.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  KINKY]]::lf::$[position.x=2.7,y=-6.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  FUNKY]]::lf::$[position.x=2.6,y=-3.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  INKY]]::lf::$[position.x=2.5,y=-0.5 $[scale.x=2,y=2 $[position.y=-0.3 $[scale.x=0.5,y=0.5 👀]]$[position.x=-1 $[scale.x=2,y=2 ᗣ]]  SUE]]::lf::]]]"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
  ### {
    name: "Snippets: Ocean Life"
    version: "0.11.1.0.001"
    author: "@box464@calckey.social"
    description: "Add your favorite MFM or code snippets to your notes with this plugin. A new menu item will be added to the create new note and reply to note actions menu."
    permissions: [] 
    config: {
      snippetTitle: {
        type: "string"
        label: "Snippet Name"
        description: "Required. A label for your snippet that will appear in the new post menu as 'Snippet: [Snippet Name]'. A concise name is better! Defaults to 'Ocean Life'"
        default: "Ocean Life"
      }
      snippetAuthor: {
        type: "string"
        label: "Snippet Author"
        description: "Not required. This will be added to the end of the snippet as 'Created by: [Snippet Author]'. Consider making it your fediverse username."
        default: "@MariaTheMartian@calckey.social"
      }
      snippetContent: {
        type: "string"
        label: "Snippet Content"
        description: "Required. The snippet that will be pasted into the user's post content."
        default: "$[x2 $[font.monospace $[fg.color=FF00FF OCEAN LIFE]]]::lf::$[x2 $[bg.color=00688B 🌊 🌊 🌊 🌊::lf::🌊 🌊 🌊 🌊::lf::🪸   ]] $[x3 $[rainbow $[position.x=-2.2 🧜‍♀️]]] ::lf::$[x2 $[position.x=4 $[position.y=-2.3 🪸]]] $[x2 $[position.x=2 $[position.y=-4.5 $[shake.speed=5s 🐠]]]] $[position.x=-3.7 $[position.y=-9.6 $[shake.speed=6s :Shiropuyo_shrimp:]]]"
      }
      blankCanvas: {
        type: "boolean" 
        label: "Blank Canvas"
        description: "Always clear the post content, then paste the snippet."
        default: no
      }
      debug: {
        type: "boolean"
        label: "Enable Debugging"
        description: "Write debugging information to the console."
        default: no
      }
    }
  }

// This plugin template was created by @box464@calckey.social
  // Want to create your own MFM Plugin? Visit https://ck-snips.box464.com

? (c.snippetTitle = "") {
    c.snippetTitle <- "Snip: Untitled"    
  } . {
    c.snippetTitle <- Arr:join(["Snip: " c.snippetTitle])
  }

@debug(comment) {
    ? (Plugin:config.debug = yes) {
      print("Plugin: Snippets")
      print(comment)
    }
  }

@effect(postForm) {
      debug("Snippets: Entering Effect Function")
      $postFormText <- ""

$_snippetContent <- c.snippetContent

? Core:eq(postForm.text, _) {
          debug("Snippets: Note was null")
        postFormText <- ""
      } . {
        postFormText <- postForm.text
      }

? (c.blankCanvas = yes) {
          postFormText <- ""
      } . {
          postFormText <- Arr:join([postForm.text Str:lf])
      }

// Add Line Feeds
      _snippetContent <- Str:replace(Str:replace(_snippetContent "::lf::", Str:lf) "::dbquote::", "\"")

postForm.text <- postFormText

debug("Snippets: Leaving Effect Function")

postForm
  }

@handler(postForm_ update) {
    debug("Begin Handler")

? (c.snippetContent = "") {
      c.snippetContent <- "$[sparkle $[x2 🎨 Default text - Replace with your custom creation here] :blobhaj_heart:]"
    }

$postFormWithSnippetAdded <- effect(postForm_)

update("text" postFormWithSnippetAdded.text)

debug("End Handler")
  }

Plugin:register_post_form_action(c.snippetTitle handler)

/// @ 0.11.1
### {
  name: "Highlighter"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Highlight a word or short phrase found in a note on your timelines. View settings to change the phrase, set colors, and enable or disable the sparkle effect."
  permissions: [] 
  config: {
    searchTerm: {
      type: "string"
      label: "Search Phrase"
      description: "Required. A word or short phrase that will be highlighted and sparkled on your timelines when found."
      default: ""
    }
    enableCompatibilityMode: {
      type: "boolean"
      label: "Compatibility Mode"
      description: "Enabled by default. Firefish instances running version v13.1.4.1 or lower do not have MFM foreground and background properties, which causes a display issue."
      default: yes
    }
    bgColor: {
      type: "string"
      label: "Background Color"
      description: "The HEX code you want to use for the background color of the search phrase. Requires Firefish version v13.2.0.0 beta or higher."
      default: "D8D7B0"
    }
    fgColor: {
      type: "string"
      label: "Text Color"
      description: "Required. The HEX code you want to use for the text color of the search phrase. Requires Firefish version v13.2.0.0 beta or higher."
      default: "31748F"
    }
    enableSparkle: {
      type: "boolean"
      label: "Sparkle Effect"
      description: "Enable sparkle effect on search phrases."
      default: yes
    }
    debug: {
      type: "boolean"
      label: "Enable Debugging"
      description: "Write debugging information to the console."
      default: no
    }
  }
}

@debug(comment) {
  ? (Plugin:config.debug = yes) {
    $_comment <- comment
    _comment <- Arr:join(["Plugin: Highlighter: " _comment])
    print(comment)
  }
}

#c = {}
c.searchTerm <- Plugin:config.searchTerm
c.bgColor <- Plugin:config.bgColor
c.fgColor <- Plugin:config.fgColor
c.enableSparkle <- Plugin:config.enableSparkle
c.enableCompatibilityMode <- Plugin:config.enableCompatibilityMode

? (c.bgColor = "") {
  c.bgColor <- "D8D7B0"
}

? (c.fgColor = "") {
  c.fgColor <- "31748F"
}

c.bgColor <- Str:replace(c.bgColor, "#", "")
c.fgColor <- Str:replace(c.fgColor, "#", "")

// The term effect is just a code pattern I use. It's not required.
// I break my code into handler and effect functions to make it easier to read and debug.
@effect(note) {
  ? (c.searchTerm != "") {
    debug("Search Term Exists 🕵🏾‍♀️")

$noteText <- ""

? Core:eq(note.text, _) {
      noteText <- ""
    } . {
      noteText <- note.text
    }

$wordReplacement <- ""

#noteUpper = Str:upper(noteText)

? (Str:index_of(noteUpper, Str:upper(c.searchTerm)) > 0) {

debug("Search Term Found")
      ? (c.enableSparkle = yes) {
        debug("✨ Starting Sparkles")
        wordReplacement <- " $[sparkle "
      }

? (c.enableCompatibilityMode = yes) {
        debug("Using Code instead of Colors")
        wordReplacement <- Arr:join([wordReplacement "$[x2  ` " c.searchTerm " ` ]"])
      } . {
        debug("Applying Colors")
        wordReplacement <- Arr:join([wordReplacement "$[x2 $[bg.color=" c.bgColor " $[fg.color=" c.fgColor "  " c.searchTerm " ]]]"])
      }

? (c.enableSparkle = yes) {
        debug("✨ Finishing Sparkles")
        wordReplacement <- Arr:join([wordReplacement "]"])
      }

debug("📚 Defining Search Term Derivatives")
      #wordReplacementHash = Str:replace(wordReplacement, c.searchTerm, Arr:join(["#" c.searchTerm]))
      #searchTerm = Str:lower(c.searchTerm)
      #searchTermLower = Str:lower(c.searchTerm)
      #searchTermUpper = Str:upper(c.searchTerm)
      #searchTermFirstUpper = Arr:join([Str:upper(Str:slice(c.searchTerm, 1, 2)) Str:lower(Str:slice(c.searchTerm, 2, (Str:len(c.searchTerm) + 1)))])
      #searchTermHashUpper = Arr:join(["#" Str:upper(c.searchTerm)])

debug("🔖 Highlighting Search Term")

noteText <- Str:replace(noteText, c.searchTerm, searchTermUpper)
      noteText <- Str:replace(noteText, searchTermLower, searchTermUpper)
      noteText <- Str:replace(noteText, searchTermFirstUpper, searchTermUpper)
      noteText <- Str:replace(noteText, Arr:join([":" searchTermUpper ":"]), searchTermLower)

noteText <- Str:replace(noteText, searchTermHashUpper, wordReplacementHash)
      noteText <- Str:replace(noteText, Arr:join([" " searchTermUpper]), wordReplacement)
      noteText <- Str:replace(noteText, searchTermUpper, wordReplacement)

debug("🎉 Returning updated note text")
      debug(noteText)
      note.text <- noteText
    }
  }

note
}

// The term handler is just my own code pattern. You can use whatever you want.
@handler(note_) {
  debug("Begin Handler")

// Apply this effect not only to the main note, but any replies or renotes as well.
  $note <- effect(note_)
  ? Obj:has(note, "renote") { note.renote <- effect(note.renote) }
  ? Obj:has(note, "reply") { note.reply <- effect(note.reply) }

debug("End Handler")

note
}

Plugin:register_note_view_interruptor(handler)

/// @ 0.11.1
### {
  name: "Share to Mastodon"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Share a Firefish post to your Mastodon account using Mastodon's share url. Will only share posts marked as public and not restricted to local viewing."
  permission: []
  config: {
    mastodon_server: {
      type: "string"
      label: "Mastodon Server Url (in the form: https://mastodon.social)"
      default: ""
    }
  }
}

@handler(note) {
  $noteText <- ""
  $canDisplay <- yes

$mastodonServer <- Plugin:config.mastodon_server
  $calckeyServer <- Mk:load("ShareToMastodon_CalckeyServer")

? ((calckeyServer = _) | (calckeyServer = "")) {
    // This API call does not require any permissions, it's a public endpoint and does not contain any personal data
    #metaData = Mk:api("meta", {})
    calckeyServer <- metaData.uri

// This saves to local storage with the naming convention of "aiscript:plugins:[PluginGuid]:[MkSaveKey]"
    // This will save to the local storage key: "aiscript:plugins:[PluginGuid]:ShareToMastodon_CalckeyServer"
    Mk:save("ShareToMastodon_CalckeyServer" calckeyServer)
  }
  
  ? ((mastodonServer = _ ) | (Str:len(mastodonServer) = 0)) {
    canDisplay <- no
      noteText <- "Add your Mastodon Server Url to the Share to Mastodon Plugin Settings"
  } . {
    mastodonServer <- Str:replace(mastodonServer, "http://", "https://")

? (Str:index_of(mastodonServer, "https") = 0) {
      mastodonServer <- Arr:join("https://" mastodonServer)
    }
  }

? ((canDisplay = yes) & (note.visibility != "public")) {
    canDisplay <- no
    ? (Str:len(noteText) > 0) {
      noteText <- Arr:join([noteText Str:lf "The note was not shared to public audiences."])
    } . {
      noteText <- "The note was not shared to public audiences."
    }
  }

? ((canDisplay = yes) & (note.localOnly = yes)) {
    canDisplay <- no
    ? (Str:len(noteText) > 0) {
      noteText <- Arr:join([noteText Str:lf "The note was only shared to the local server."])
    } . {
      noteText <- "The note was only shared to the local server."
    }
  }

? (canDisplay = yes) {
    effect(note, calckeyServer)
  } . {
   Mk:dialog("Note can't be shared." noteText)
  }

note
}

@effect(note_, calckeyServer_) {
  $userHost <- note_.user.host
  $noteUrl <- note_.url
  ? (userHost = _) {
    userHost <- Str:replace(calckeyServer_, "https://", "")
  }

? (noteUrl = _) {
    noteUrl <- Arr:join([calckeyServer_ "/notes/" note_.id])
  }
    
  $noteText <- Str:replace(Str:replace(Arr:join(["Sharing a post from @" note_.user.username "@" userHost]) "/" "%2F") "#" "%23")

noteText <- Arr:join([noteText "%0A%0A" noteUrl])

Plugin:open_url(Arr:join([Plugin:config.mastodon_server "/share?text=" noteText]))

note_
}

Plugin:register_note_action("Share to Mastodon" handler)

/// @ 0.11.1
### {
  name: "Lister"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Adds a new action item to notes that allows you to add the account to a specific list. Find the Ids of your lists by going to: https://your.firefish/my/lists, click on list, and the Id will be the last bit in the url (i.e. https://firefish.social/my/lists/9e323h6hwx, you'll copy 9e323h6hwx for the List Id)"
  permissions: ["write:account", "read:account"] 
  // Write:Account is required to add users to a list, see https://calckey.social/api-doc#operation/users/lists/push
  // Read:Account is required to retrieve the users existing in a list, see https://calckey.social/api-doc#operation/users/lists/show
  config: {
     debug: {
      type: "boolean"
      label: "Enable Debugging"
      description: "Write debugging information to the console."
      default: no
    }
    list01Id: {
      type: "string"
      label: "List 1: Id"
      description: "Required. The Id of your associated list."
      default: ""
    }
    list01Name: {
      type: "string"
      label: "List 1: Short Name"
      description: "An abbreviated version of the list name that will appear as the menu action item."
      default: ""
    }
    list02Id: {
      type: "string"
      label: "List 2: Id"
      description: "The Id of your associated list."
      default: ""
    }
    list02Name: {
      type: "string"
      label: "List 2: Short Name"
      description: "An abbreviated version of the list name that will appear as the menu action item."
      default: ""
    }
    list03Id: {
      type: "string"
      label: "List 3: Id"
      description: "The Id of your associated list."
      default: ""
    }
    list03Name: {
      type: "string"
      label: "List 3: Short Name"
      description: "An abbreviated version of the list name that will appear as the menu action item."
      default: ""
    }
  }
}

@debug(comment) {
  ? (Plugin:config.debug = yes) {
    print("Plugin: Add to List")
    print(comment)
  }
}

// Create an object to hold the configuration variables
#c = {}
    c.list01Id <- Plugin:config.list01Id
    c.list01Name <- Plugin:config.list01Name
    c.list02Id <- Plugin:config.list02Id
    c.list02Name <- Plugin:config.list02Name
    c.list03Id <- Plugin:config.list03Id
    c.list03Name <- Plugin:config.list03Name
    c.debug <- Plugin:config.debug

@formatListName(listName, listNumber) {
  $listName_ <- listName
  $listNumber_ <- listNumber

? ((listName_ = _) | (Str:len(listName_) = 0)) {
      listName_ <- Arr:join(["Add to List " listNumber_])
  } . {
    listName_ <- Arr:join(["Add to List: " listName_])
  }

listName_

}

c.list01Name <- formatListName(c.list01Name, "01")
c.list02Name <- formatListName(c.list02Name, "02")
c.list03Name <- formatListName(c.list03Name, "03")

@effect(note, listName, listId) {
  #note_ = note
  #listName_ = listName
  #listId_ = listId

debug("Begin Effect")
  debug(Arr:join(["EF List Id: " listId]))
  debug(Arr:join(["EF List Name: " listName]))

// Check if the user already exists in the list
  #validationPayload = {
    listId: listId_
  }

#validationResponse = Mk:api("users/lists/show", validationPayload)
  $userFound <- Arr:find(validationResponse.userIds, @(item) { (item = note_.user.id ) } )

// Another way to do it...
  //~~ (#item, validationResponse.userIds) {
  //  ? (item = note_.user.id) {
  //    userFound <- yes
  //  }
  //}

? (userFound != _) {
      Mk:dialog("Not Added" Arr:join(["User: '" note_.user.username "' was already in the list."] "info"))
  } . {
    #payLoad = {
      listId: listId_,
      userId: note_.user.id
    }

#response = Mk:api("users/lists/push", payLoad)

debug(Json:stringify(response))

#message = Arr:join([note_.user.username " was added to the list: " listName_ "."])

Mk:dialog("Added" message "success")

}
  
  debug("End Effect")

note_
}

@generalHandler(_note, _listName, _listId) {
  // Handler should assure all properties are valid before turning over to the effect
  debug("Begin Handler")

$note <- _note
  $listName <- _listName
  $listId <- _listId

debug(Arr:join(["H List Id: " listId]))
  debug(Arr:join(["H List Name: " listName]))

note <- effect(note, listName, listId)

debug("End Handler")

note

}

// Break code into a handler function and an effect function for clarity
Plugin:register_note_action(c.list01Name @(note) {
  generalHandler(note, Plugin:config.list01Name, c.list01Id)
})

? ((c.list02Id != _) & (Str:len(c.list02Id) > 0)) {
  Plugin:register_note_action(c.list02Name @(note) {
    generalHandler(note, Plugin:config.list02Name, c.list02Id)
  })
}

? ((c.list03Id != _) & (Str:len(c.list03Id) > 0)) {
  Plugin:register_note_action(c.list03Name @(note) {
    generalHandler(note, Plugin:config.list03Name, c.list03Id)
  })
}

/// @ 0.11.1
### {
  name: "Post Template"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Paste a templated phrase or MFM creations to your posts and replies with one click. Replace line feeds with ::lf:: and quotes with ::qt::"
  permissions: [] 
  config: {
    templateTitle: {
      type: "string"
      label: "Template Title"
      description: "10 characters or less, a title for your creation that will appear in the post action menu. Defaults to 'Post Template'"
      default: "Post Template"
    }
    templateText: {
      type: "string"
      label: "Template Text"
      description: "The phrase or MFM you'd like to appear. Create line feeds with ::lf:: and quotes with ::qt::"
      default: ""
    }
    debug: {
      type: "boolean"
      label: "Enable Debugging"
      description: "Write debugging information to the console."
      default: no
    }
  }
}

#c = {}
c.debug <- Plugin:config.debug
c.templateText <- Plugin:config.templateText
c.templateTitle <- Plugin:config.templateTitle

? (c.templateTitle = "") {
  c.templateTitle <- "Post Template"    
} . {
  c.templateTitle <- Arr:join(["Template: " c.templateTitle])
}

@debug(comment) {
  ? (Plugin:config.debug = yes) {
    $comment <- Arr:join(["Plugin Post Template: " comment])
    print(comment)
  }
}

@effect(postForm) {
    debug("Entering Effect Function")
    $postFormText <- ""

$_templateText <- c.templateText

? Core:eq(postForm.text, _) {
        debug("Note was null")
      postFormText <- ""
    } . {
      postFormText <- postForm.text
    }

postFormText <- Arr:join([postForm.text Str:lf])

// Add Line Feeds
    _templateText <- Str:replace(Str:replace(_templateText "::lf::", Str:lf) "::qt::", "\\"")

postFormText <- Arr:join([postFormText _templateText])

postForm.text <- postFormText

debug("Leaving Effect Function")

postForm
}

@handler(postForm_ update) {
  debug("Begin Handler")

? (c.templateText = "") {
    c.templateText <- "$[sparkle Replace with your own text or MFM creations]"
  }

$postFormWithTemplateAdded <- effect(postForm_)

update("text" postFormWithTemplateAdded.text)

debug("End Handler")
}

Plugin:register_post_form_action(c.templateTitle handler)

/// @ 0.11.1
### {
  name: "For Followers Only"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Adds an identifier to the top of notes in your timeline that are meant for followers and mentioned users."
  permissions: [] 
  config: {
    debug: {
      type: "boolean"
      label: "Enable Debugging"
      description: "Write debugging information to the console."
      default: no
    }
  }
}

@debug(comment) {
  ? (Plugin:config.debug = yes) {
    ? (Core:type(comment) = "obj") {
      ? (comment != _) {
        print("🔌 Plugin: " Core:type(comment) " Object")
        print(comment)
      }
    } . {
      $comment_ <- Core:to_str(comment)
      ? ((comment_ != _) & (Str:len(comment_) > 0)) {
        print(Arr:join(["🔌 Plugin: " comment_]))
      }
    }
  }
}

@effect(note) {
    debug("Entering Effect Function")

$noteText <- ""

? Core:eq(note.text, _) {
      debug("Note was null")
      noteText <- ""
    } . {
      noteText <- note.text
    }

// At this point you have access to the note object
    // This effect will run on each note that is visible in your timeline.
    // https://calckey.social/api-doc#operation/notes/timeline
    // You can read data from each note and manipulate it in some way.
    // In this example, notes that are set to "Followers Only" are given a sparkle effect.

? (note.visibility = "followers") {
      noteText <- Arr:join(["> 👀 $[sparkle For Followers and Mentioned Users Only] 👀 " Str:lf Str:lf noteText])
    }

note.text <- noteText

debug("Leaving Effect Function")

note
}

@handler(note_) {
  debug("Begin Handler")

$note <- effect(note_)
  ? Obj:has(note, "renote") { note.renote <- effect(note.renote) }
  ? Obj:has(note, "reply") { note.reply <- effect(note.reply) }

debug("End Handler")

note
}

Plugin:register_note_view_interruptor(handler)

@effect(note) {
    debug("Entering Effect Function")

$noteText <- ""

? Core:eq(note.text, _) {
      debug("Note was null")
      noteText <- ""
    } . {
      noteText <- note.text
    }

? (note.visibility = "followers") {
      noteText <- Arr:join(["> 👀 $[sparkle For Followers and Mentioned Users Only] 👀 " Str:lf Str:lf noteText])
    }

note.text <- noteText

debug("Leaving Effect Function")

note
}

@handler(note_) {
  debug("Begin Handler")

$note <- effect(note_)
  ? Obj:has(note, "renote") { note.renote <- effect(note.renote) }
  ? Obj:has(note, "reply") { note.reply <- effect(note.reply) }

debug("End Handler")

note
}

Plugin:register_note_view_interruptor(handler)

/// @ 0.11.1
### {
  name: "List My Pages"
  version: "0.11.1.0.001"
  author: "@box464@calckey.social"
  description: "Displays links to your public and private Firefish pages. Requires read only access to your pages content."
  permissions: ["read:pages"] 
  config: {
    debug: {
      type: "boolean"
      label: "Enable Debugging"
      description: "Write debugging information to the console."
      default: no
    }
  }
}

#c = {}
c.debug <- Plugin:config.debug

@debug(comment) {
  ? (Plugin:config.debug = yes) {
    $comment <- Arr:join(["Plugin Post Template: " comment])
    print(comment)
  }
}

@effect(postForm) {
    debug("Entering Effect Function")
    $postFormText <- ""

? Core:eq(postForm.text, _) {
        debug("Note was null")
      postFormText <- ""
    } . {
      postFormText <- postForm.text
    }

// It only returns the first 40 pages, so if you are page crazy...it's not going to return everything
    // Retrieve all pages for the current user
    #pages = Mk:api("i/pages" { limit: 40 })
    #meta = Mk:api("meta" { })

$pageFound <- no

~~ (#page, pages) {
      $isPublic <- ""
      ? (page.isPublic = yes) { isPublic <- " (🟢 Public) " } . { isPublic <- " (🔴 Private) " }
      $url <- Arr:join(["[" page.title "](" meta.uri "/@" page.user.username "/pages/" page.name ")" isPublic Str:lf])  
      postFormText <- Arr:join([postFormText url])
      pageFound <- yes
    }

? (pageFound = no) {
      postFormtext <- Arr:join([postFormText "You don't have any public or private Firefish Pages. Go [create one](/pages/new)!"])
    }

postForm.text <- postFormText

debug("Leaving Effect Function")

postForm
}

@handler(postForm_ update) {
  debug("Begin Handler")

$postFormWithTemplateAdded <- effect(postForm_)

debug("End Handler")

update("text" postFormWithTemplateAdded.text)
}

Plugin:register_post_form_action("My Pages" handler)

Firefish Snippets Collection

How to Install a Plugin

Code Copied to Clipboard

Error Copying to Clipboard