mirror_maker/miceco
1
0
Fork 0
mirror of https://github.com/fotoente/MiCECo.git synced 2024-10-22 23:19:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1 from EpicnessTwo/patch-1

Browse source 
Grammatical changes
This commit is contained in:
fotoente 2022-02-06 16:57:17 +01:00 committed by GitHub
commit 24b9068e17
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,7 +2,7 @@
**M**isskey **C**ustom **E**moji **Co**unter **M**isskey **C**ustom **E**moji **Co**unter
### Introduction ### Introduction
This little script counts custom emojis and used reactions form the day before and notes them automaticaly to Misskey. There is a option if Reactions should be counted as well. This little script counts custom emojis and used reactions from the previous day and automaticaly creates a note on your Misskey account with an overview. There is also an option to include reaction emojis in the counts too.
*Example Note (with counting of Reactions activated)*: https://ente.fun/notes/8wexz5ov1q *Example Note (with counting of Reactions activated)*: https://ente.fun/notes/8wexz5ov1q
@ -10,24 +10,24 @@ This little script counts custom emojis and used reactions form the day before a
Clone the repository into a folder of your choice with `git clone https://github.com/fotoente/MiCECo.git` Clone the repository into a folder of your choice with `git clone https://github.com/fotoente/MiCECo.git`
Edit the file `example-miceco.cfg` (see table below) and save it as `miceco.cfg` Edit the file `example-miceco.cfg` (see table below) and save it as `miceco.cfg`
You are now ready to run the script with any Python3 Version you like. You are now ready to run the script with any Python3 version.
I recommend using a cronjob to let it run on a daily basis. I recommend using a cronjob to let it run on a daily basis.
In your console type `crontab -e` In your console type `crontab -e`
Add `0 9 * * * python3 /path/to/file/miceco.py > /path/to/file/miceco_output.txt` Add `0 9 * * * python3 /path/to/file/miceco.py > /path/to/file/miceco_output.txt`
The script will now be run every day on 9:00am server time. The script will now be run every day on 9:00am server time.
### Options in cfg ### Options for the config file
|Name|Values|Explanation| |Name|Values|Explanation|
|----|----|----| |----|----|----|
|instance|domain.tld|Put here the domain of the Misskey instance you want to read the notes from. Only domain name and TLD, no `/`,`:` or `https` |instance|domain.tld|The domain name for your Misskey instance that you want to read the notes from. Only supply the domain name and TLD, no `/`,`:` or `https`
|user|`username`|The user you want to read the notes from| |user|`username`|The user you want to read the notes from|
|token|`String`|The token from your bot. Needs right to write notes| |token|`String`|The token for your bot. Needs permission to write notes|
|getReaction|`Boolean`|Should reactions of yesterday be counted as well? `True` or `False`| |getReaction|`Boolean`|Should reactions emojis be counted as well? `True` or `False`|
### Other notes ### Other notes
The script is written in a way that always the notes and reactions from yesterday(!!!) are caught and counted. There is no option at the moment so you can change the period. The script is written in a way that only the notes and reactions from yesterday(!!!) are caught and counted. There is no option currently to specify the date range for collection.
The exact timestamp to get yesterday is determined by the timezone of your server. At the moment there is no way to change the timezone. The exact timestamp to get yesterday is determined by the timezone of your server. At the moment there is no way to change the timezone.
#### Feel free to open a feature request or issue if you want something changed! #### Feel free to open a feature request or issue if you want something changed!