Skip to content

README.md: Added wayfire.ini config & troubleshooting section #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2025
Merged

README.md: Added wayfire.ini config & troubleshooting section #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad71ab9
Update README.md
Sravdar Feb 21, 2025
d267978
Apply suggestions from code review
Sravdar Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ cd pywayfire
python3 -m pip install .
```

### Configure wayfire.ini

Activate following plugins. `stipc` only needed when `wayfire.extra.stipc` is used.
```ini
[core]
plugins = \
ipc \
ipc-rules \
stipc
...
```

### Usage examples

Basic usage is simple, import the `wayfire.ipc` module, create a socket (it will auto-detect the compositor by using the `WAYFIRE_SOCKET` environment variable) and call its functions:
Expand All @@ -31,3 +43,11 @@ print(socket.list_views())
```

Many examples can be found in the `scripts` directory.

## Troubleshooting

**"Failed to find a suitable Wayfire socket!"**

Make sure `ipc` and `ip-rules` plugins are activated. Try running with environmental variable:
`WAYFIRE_SOCKET=/run/user/$(id -u)/wayland-1`