Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 2.97 KB

README.md

File metadata and controls

50 lines (29 loc) · 2.97 KB
Raw

FreshPresence

A tiny background app providing Discord Rich Presence for the LittleBigPlanet games on Refresh-based servers.

Discord

Compatibility

FreshPresence is only designed for the Refresh v3 API, so FreshPresence will not work with alternative servers.

Additionally, LBP1 will only have limited rich presence.

Running

Legalties

Warning

FreshPresence is still early in development, as such we cannot make any guarantees about anything. You use FreshPresence at YOUR OWN RISK. FreshPresence is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Note

FreshPresence is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Anyway, with the legal disclaimers out of the way...

Instructions

From Releases

  1. Find the latest release
  2. Download the version for your OS/CPU, extract it somewhere most convenient to you, and run it.
  3. It will open a message box asking if you want to edit the config file, press Yes, then update the fresh_presence_config.ini file to contain your username and preferred settings.
  4. Open FreshPresence once more, and it should now show your profile on Discord.

To update, you can simply repeat this process, overwriting the previous file.

It's on fire! What do I do?

FreshPresence isn't perfect, so it's not exactly uncommon to run into bugs. If you'd like, you can create an issue here on GitHub or join our Discord for support.

Wherever you choose to post, be sure to include details about how to trigger the bug, text logs (not screenshots!), your environment, the bug's symptoms, and anything else you might find relevant to the bug.

Building & Contributing

To contribute to FreshPresence, it may be helpful to refer to our contributing guide to get a basic development environment set up. If you're a pro, feel free to skip this as it's just your bog-standard Zig set-up guide.

However, something important for all those involved: we also serve additional documentation relating to FreshPresence, Refresh, Bunkum, and LittleBigPlanet in general in our Docs repo.

Made with ❤️ for the LittleBigPlanet community