1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..69df07b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# usermoji
+
+fun tools to create emojis based on pfps.
+
+base pfps are stored as pngs in [](plain/).
+
+## thoughts
+
+`make thoughts` or `./mkthoughs infile.png outfile.png [bgcolor]`
+
+requires imagemagick.
+
+when using make:
+
+- output is stored in [](out/thoughts/).
+- file [](thoughts/colors.txt) can be used to specify a background color for each user (default white).
+
+## petpet
+
+`make petpet` or `./tools/petpet/init.js infile.png outfile.gif`
+
+petpet generator was ported to nodejs, based on [](https://benisland.neocities.org/petpet/) which is browser-only. i can't be assed to rewrite this to a more sane language.
+
+make sure to install deps for petpet generator: `cd tools/petpet && npm install`.
+
+when using make, output is stored in [](out/petpet/).
+
+## cube
+
+`make cube` or `./mkcube infile.png outfile.gif`
+
+by far the most cursed one, using vkcube to render.
+
+only works on sway. requires wf-recorder, jq, ffmpeg and imagemagick.
+
+make sure to build vulkan tools: `cmake -S tools/Vulkan-Tools -B tools/Vulkan-Tools/build && make -C tools/Vulkan-Tools/build vkcube`.
+
+make sure to add sway config rule: `for_window [title="^vkcube$"] floating enable`.
+
+when using make, output is stored in [](out/cube/).