From d3b08deb3a9e9cbfeddb31351b39a885352ce047 Mon Sep 17 00:00:00 2001 From: Junko Date: Sun, 26 Nov 2023 11:20:52 +0100 Subject: [PATCH] module docs --- README.org | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index 4f66b1e..bfabdfb 100644 --- a/README.org +++ b/README.org @@ -49,9 +49,16 @@ Writes the known list of members based on the =system.json= file. ** Modules *** PFP module -requires docs +Will get a profile picture from a folder based on the currently fronting members and will copy it to the desired location. I recommend something it's easy to have at hand like =~/face=. + +The pictures in the path should be named according to the front. For example, if Bob and Alice are fronting, the module will copy ={PATH}/bobalice.png= to the location, or if it's only Bob it'll be =bob.png=. +Notice this will cover all combinations, if the main front is Alice the combination =alicebob.png= instead. I recommend the use of a python script to generate the possible combinations. + *** Discord module -goes against ToS be gentle +**Use of this module goes against discord terms of service. USE AT YOUR OWN RISK.** + +Requires the =PFP module= to be enabled and the latest version of [[https://github.com/dolfies/discord.py-self/][discord.py-self]]. +Will change your discord avatar with the one selected by the PFP module. * Future Given the nature of the project as a learning exercise, there are currently a set of features and improvements I'd like to add eventually.