junkyard/pluralsync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

module docs

Browse source
This commit is contained in:
Junko 2023-11-26 11:20:52 +01:00
parent 9870ce5aa6
commit d3b08deb3a
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.org
View file

@ -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.