jmetz / emulsion Goto Github PK

Refer to the website for an overview.

Emulsion is targeting Windows, Mac, and Linux although it is currently only being tested on Linux and Windows. A note for Linux users: Wayland support is limited, so for example expect high CPU usage and the title text not being shown. However X is fully supported.

To build the software, obtain the latest stable release of Rust and after navigating to the source directory simply run the command cargo build --release using your preferred command line interface.

Contribution is welcome. Feel free to post feature requests, bug reports, and make pull requests.

When installing Emulsion through the Windows installer, Emulsion will have networking enabled and will by default check for updates. However none of the other versions have networking and neither does default feature-set. This also means that Emulsion will not have networking dependent capabilities when invoking

cargo install emulsion

To enable such features when installing with cargo, run

cargo install emulsion --features=networking

If Emulsion closed unexpectedly please locate the "panic.txt" file. This file has a different location depending on the target platform.

• Windows: %localappdata%\emulsion\data
• MacOS: $HOME/Library/Application Support/emulsion
• Linux: $XDG_DATA_HOME/emulsion or $HOME/.local/share/emulsion

When posting a bug report please upload the contents of this file to GitHub. If you deem it too large just paste the last panic entry between the rows of equal signs. If there's no "panic.txt" file, describe the scenario in which you experienced the faulty behaviour, and steps to reproduce it if you believe that could help.