OSSForks/SamRewritten
1
0
Fork 0
mirror of https://github.com/zebrajr/SamRewritten.git synced 2025-12-06 00:19:47 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Minor README update

Browse Source
This commit is contained in:
PaulCombal 2023-04-29 01:22:02 +01:00 committed by GitHub
parent 94b33c7340
commit 8e8b7347b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -16,22 +16,25 @@ A Steam Achievements Manager for Linux
# Introduction
SamRewritten is an open-source program that allows you to unlock and relock your Steam achievements. It is named after the famous Steam Achievement Manager written by Gibbed, and implements its functionalities on Linux, and more!
SamRewritten is an open-source desktop application that allows you to unlock and relock your Steam achievements. It is named after the famous Steam Achievement Manager [written by Gibbed](https://github.com/gibbed/SteamAchievementManager), and implements its functionalities on Linux, and more!
It comes with third-party tools integration and a nice user interface.
SamRewritten is constantly under development, if you think you can give us a hand, feel free to reach us :)
SamRewritten is always evolving, we would be thrilled to listen to your feedback, ideas, and contributions!
### ⚠️ SamRewritten only works if Steam has been installed through your package manager (apt, pacman, ...).
### ⚠️ Flatpak is *not* supported but contributions are welcome!
# Installation
AppImage downloads are readily available from [the releases tab](https://github.com/PaulCombal/SamRewritten/releases).
Arch users can install SamRewritten from the AUR by installing the `samrewritten-git` package.
Run SamRewritten by opening the corresponding desktop entry, or by using the `samrewritten` command.
On Gentoo, SamRewritten is available as `games-util/samrewritten` through [the GURU overlay](https://wiki.gentoo.org/wiki/Project:GURU).
# Building
To build this project, clone this repository on your PC, and run the `make` command within the repository folder that you downloaded.
Alternatively, you can download one of our releases in the AppImage format. Check the 'Release' tab of this repository to find them.
To build your own AppImage, build SamRewritten normally, then execute `build_appimage.sh` in the `package` folder, it will take care of everything for you.
To build this project from source, clone and enter this repository, and run `make`.
For Arch users, there is also a PKGBUILD within the `package` folder if you wish to build it using `makepkg`.
If you're encountering issues building SamRewritten, make sure you have installed the required packages on your machine. You'll most likely need Steam, curl, yajl, GTK 3, and GLib.
@ -44,19 +47,10 @@ If you're encountering issues building SamRewritten, make sure you have installe
* **Fedora 32+**: `$ sudo dnf install gtkmm30 gtkmm30-devel yajl-devel curl-devel g++`
To run SamRewritten, simply launch `$ ./bin/launch.sh`
## AUR Installation
To run your SamRewritten build, use `$ ./bin/launch.sh`
You can install SamRewritten from the AUR by installing the `samrewritten-git` package.
Run SamRewritten by opening the corresponding desktop entry, or by using the `samrewritten` command.
## Gentoo Installation
SamRewritten is available as `games-util/samrewritten` through the GURU overlay:
https://wiki.gentoo.org/wiki/Project:GURU
To build your own AppImage, build SamRewritten normally, then execute `build_appimage.sh` from the `package` folder. A new AppImage will be generated with libraries from your system.
# Features
@ -71,11 +65,11 @@ SamRewritten's features match and exceed the original SAM:
* Ability to show percent of players who achieved an achievement
* Ability to time achievement modifications
This last one warrants some explanation. SamRewritten allows you to specify across what time period, with what spacing, and in what order to lock/unlock achievements. For example, you can unlock 10 achievements of your choice in a random order across 4 hours with random spacing between them. This is a powerful tool to allow you to make achievement management look more normal, rather than unlocking them all at once. This option can be accessed in the GUI by starting a game -> inputting the achievement modifications -> click the menu -> Start Timed Modifications -> choose your parameters -> Submit. The same functionality can be used with the CLI as well via the `--timed` parameter - an example is given below.
This last one warrants some explanation. SamRewritten allows you to specify across what time period, with what spacing, and in what order to lock/unlock achievements. For example, you can unlock 10 achievements of your choice in a random order across 4 hours with random spacing between them. This is a powerful tool to allow you to make achievement management look more natural, rather than unlocking them all at once. This option can be accessed in the GUI by starting a game, selecting the achievement modifications, click the menu icon, then selcting Start Timed Modifications. The same functionality can be used with the CLI as well via the `--timed` parameter - an example is given in the next section.
# Command line options
I know you linux geeks love to use command line options! SamRewritten's commandline can do all the operations its GUI can! If no commandline arguments are given, the GUI will be launched.
As linux geeks we love to use command line options! SamRewritten's commandline can do all the operations its GUI can! Given no arguments, SamRewritten will launch graphically.
```
Usage:
@ -153,12 +147,12 @@ samrewritten 54 --timed --unlock ach_500_kills,ach_found_something --amount 4 --
## Third-party apps integration
SamRewritten uses JSON to communicate between the interface and the "backend logic". Communications are transmitted via unix sockets. If you plan to make an app using some of SamRewritten's features, feel free to ask for help, for features, or to contribute.
SamRewritten uses JSON to communicate between the interface and the "backend logic" via sockets. If you plan to make an app using some of SamRewritten's features, feel free to ask for help, for support, for features, or to contribute.
## I want to contribute, where to start?
You can find an overview of SamRewritten's internal logic and more [here, in the doc folder](doc/OVERVIEW.md).
You can find an overview of SamRewritten's internal logic and more [in the doc folder](doc/OVERVIEW.md). If you need more help getting started, feel free to ask questions and open issues. The more feedback we collect, the better we can make the documentation!
## Footnotes
This software is licensed under the GNU GPL v3 and comes with no warranty. Use it at your own risk. We believe you should not get any ban using it, but we do not take any responsibility over your user experience.
This software is licensed under the GNU GPL v3 and comes with no warranty. Use it at your own risk. We believe you should not get any Steam ban using it, but we do not take any responsibility over your user experience.