oat
/
funfriend
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Jill 2023-06-02 23:41:35 +03:00
parent 49ce6885ea
commit 75a7535e4d
Signed by: oat
GPG Key ID: 33489AA58A955108
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -6,9 +6,21 @@ little desktop buddy for your computer
currently just kind of sits and wanders around
you can right click to catmode
## configuration
config is in `~/.config/funfriend/` or `%AppData%/funfriend/` or `~/Library/Application Support/funfriend`
config location depends on your OS:
| | |
| - | - |
| Windows | `%AppData%/funfriend/` |
| OSX | `~/Library/Application Support/funfriend/` |
| Linux | `~/.config/funfriend/` |
inside you'll find `cfg.ini`. most keys should be self-explanatory, but here's a few notable ones
### `buddies.types`
comma-seperated types of buddies to add, ex. `funfriend,funfriend,god` for 2 funfriends and 1 god. pass in something invalid to print out a list of valid options
## installation