freshpresence's Introduction

FreshPresence

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

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 Github Actions

Find the latest run
Download the artifact for your OS, extract it somewhere most convenient to you, and run it.
Once it closes, update the fresh_presence_config.ini file to your preferred settings, set your username, then save and close the file.
Open FreshPresence once more, and it should now show your profile.

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 setting up Zig 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

freshpresence's People

Contributors

Stargazers

Watchers

freshpresence's Issues

Windows' cmd doesn't support vt100 color codes

Support `assetConfiguration.useApplicationAssets`

LittleBigRefresh/Refresh@c305f3c

Add button to open config in text editor upon first startup

Right now it just tells you the filename and tells you to edit it, but we should have a button to open it in a system installed text editor, whether it be notepad on windows, or on linux where we just have a list of like 20 to try in order

Missing default config is not detected properly

[jvyden@the-overcooler bin]$ ./FreshPresence 
error: FileNotFound
/usr/lib/zig/lib/std/os.zig:1719:23: 0x2c647b in openatZ (FreshPresence)
            .NOENT => return error.FileNotFound,
                      ^
/usr/lib/zig/lib/std/fs.zig:1534:25: 0x2c5d92 in realpathZ (FreshPresence)
            else => |e| return e,
                        ^
/usr/lib/zig/lib/std/fs.zig:1520:9: 0x2c6bc4 in realpath (FreshPresence)
        return self.realpathZ(&pathname_c, out_buffer);
        ^
/usr/lib/zig/lib/std/fs.zig:1608:35: 0x2c7131 in realpathAlloc (FreshPresence)
        return allocator.dupe(u8, try self.realpath(pathname, buf[0..]));
                                  ^
/home/jvyden/Documents/FreshPresence/src/config.zig:29:21: 0x2caf25 in getConfig (FreshPresence)
    var full_path = try (config_dir orelse cwd).realpathAlloc(allocator, config_filename);
                    ^
/home/jvyden/Documents/FreshPresence/src/main.zig:31:20: 0x2d74c0 in runApp (FreshPresence)
    const config = try Config.getConfig(allocator);
                   ^
/home/jvyden/Documents/FreshPresence/src/main.zig:26:9: 0x2dce2c in main (FreshPresence)
        return err;
        ^

Recommend Projects