Go to file
mariuszkurek 6e059d4838 Good question 2022-10-10 10:21:34 +02:00
.circleci Unify structure with other plugins 2019-08-07 15:07:45 +02:00
build [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
server Good question 2022-10-10 10:21:34 +02:00
.editorconfig Unify structure with other plugins 2019-08-07 15:07:45 +02:00
.gitignore Unify structure with other plugins 2019-08-07 15:07:45 +02:00
.gitpod.yml Create .gitpod.yml (#59) 2022-05-06 12:26:56 -04:00
.golangci.yml [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
CODEOWNERS Define maintainer 2020-04-09 17:21:56 +02:00
LICENSE Create LICENSE 2017-12-21 16:05:36 -06:00
Makefile - darwin, win64 2022-09-13 16:28:27 +02:00
README.md fixed misleading anti-example in README (#49) 2021-05-21 18:10:27 +02:00
go.mod [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
go.sum [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
plugin.json - darwin, win64 2022-09-13 16:28:27 +02:00
screenshot.png add screenshot, travis.yml, bump version to 0.1 2017-12-21 15:25:22 -06:00

README.md

Mattermost Memes Plugin

Build Status Code Coverage

Maintainer: @hanzei

This plugin will create a slash command that you can use to create memes!

/meme everywhere "memes." "memes everywhere"

For more information like available memes or command syntax type /meme and press enter.

Installation

From Mattermost 5.16 and later, the Memes Plugin is included in the Plugin Marketplace which can be accessed from Main Menu > Plugins Marketplace. You can install the Memes plugin there.

In Mattermost 5.15 and earlier, follow these steps:

  1. Go to https://github.com/mattermost/mattermost-plugin-memes/releases/latest to download the latest release file in zip or tar.gz format.
  2. Upload the file through System Console > Plugins > Management. See documentation for more details.

Development

Read our documentation about the Developer Workflow and Developer Setup for more information about developing and extending plugins.

Run make memelibrary to bundle up the meme assets (images, fonts, etc.).

For convenience, you can run the plugin from your terminal to preview an image for a given input. For example, on macOS, you can run the following to generate the above meme and open it in Preview:

go run server/plugin.go -out demo.jpg 'memes. memes everywhere' && open demo.jpg

This is especially useful when adding or modifying memes as you can quickly modify assets, make memelibrary, and preview the result using the above command. (See the files in memelibrary/assets to get started with that.)