Create readme.md

This commit is contained in:
coolesding 2023-09-24 20:29:50 +02:00 committed by GitHub
parent 5faa9cd148
commit 97e7f245e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

27
db/readme.md Normal file
View file

@ -0,0 +1,27 @@
# If you aren't sure exactly what all this is about, read here first
### data.json
This is the file that the Vendetta plugin imports for now, Vendetta checks the profile pictures using the user ID and the badges are checked based on Username. This has to be fixed in the Plugin or else it will NOT work otherwise.
### datadesktop.json
This is the file that dist.css is built from. Here Badges and Profilepictures are based on user ID, more on template.css
### dist.css
This is the CSS code users import, here the data from datadesktop.json is used according to template.css.
### template.css
This is the file where the instruction on how to use datadesktop.json lies. If the (pseudo)CSS in this file says "Take the ID of the user and replace the avatar of them with the URL next to their name" this is how dist.css is built.
Example:
.{ID} {
display: none;
}
Would then build the dist.css in a way that would display: none, so hide, every avatar from a user that has the import to dist.css
of course this exact line wouldn't work because it would be to easy, thats why the selectors in this file are so long lol.