mirror of
https://github.com/zebrajr/SamRewritten.git
synced 2025-12-06 12:19:51 +01:00
Compare commits
58 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
62eb73e907 | ||
|
|
88572c8e42 | ||
|
|
02fea42346 | ||
|
|
75504d6115 | ||
|
|
bf7e772101 | ||
|
|
14f953c1f2 | ||
|
|
d6eb2106d8 | ||
|
|
cac0291f3e | ||
|
|
d5d7a9d693 | ||
|
|
b18a009c20 | ||
|
|
39d524a726 | ||
|
|
e6cda85bd8 | ||
|
|
2762330a2d | ||
|
|
8e8b7347b1 | ||
|
|
94b33c7340 | ||
|
|
895b5e3865 | ||
|
|
35f17886e4 | ||
|
|
ddd20e3e91 | ||
|
|
9bc4d994b3 | ||
|
|
3330f0fb51 | ||
|
|
d0cdadf23e | ||
|
|
10c44b4665 | ||
|
|
e87f8f7ce0 | ||
|
|
0361fb314a | ||
|
|
04f02fe69d | ||
|
|
6bf70021d2 | ||
|
|
5ebf942eea | ||
|
|
5189b20acc | ||
|
|
f0f3c7de57 | ||
|
|
dc50634f10 | ||
|
|
be64ba67b3 | ||
|
|
d928423c23 | ||
|
|
3e8d088823 | ||
|
|
06ec04978d | ||
|
|
598a8f7672 | ||
|
|
26cc90c44d | ||
|
|
8fe0c4891f | ||
|
|
730a2c22e9 | ||
|
|
2d9cd93f53 | ||
|
|
dda0177fae | ||
|
|
e4b3cbc495 | ||
|
|
09dc1da764 | ||
|
|
e006406f1c | ||
|
|
86c93160f4 | ||
|
|
1f24b85fb4 | ||
|
|
c4a76314b8 | ||
|
|
e5b2bcc448 | ||
|
|
f8dbc12d12 | ||
|
|
c2e563bcea | ||
|
|
575531a2b4 | ||
|
|
5264bd8746 | ||
|
|
2efa21ab37 | ||
|
|
e5a81a2d2b | ||
|
|
7984347db0 | ||
|
|
58c3ee8a74 | ||
|
|
2a9fe6f5ee | ||
|
|
f4daddddec | ||
|
|
fbfbcba1a7 |
36
.github/workflows/build.yml
vendored
Normal file
36
.github/workflows/build.yml
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# GitHub actions workflow.
|
||||
# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
|
||||
|
||||
name: Build CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, fix-*, feat-*]
|
||||
tags: [v*]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-22.04]
|
||||
cc: [gcc]
|
||||
runs-on: ${{ matrix.os }}
|
||||
env:
|
||||
CC: ${{ matrix.cc }}
|
||||
steps:
|
||||
- run: sudo apt-get update -y
|
||||
- run: sudo apt-get install -y libgtkmm-3.0-dev libcurl4-gnutls-dev libyajl-dev valgrind
|
||||
- uses: actions/checkout@v3
|
||||
- run: make
|
||||
- run: sudo make install
|
||||
- run: make clean
|
||||
- run: which samrewritten
|
||||
- run: cd package && ./build_appimage.sh
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: SamRewritten
|
||||
path: package/Sam*.AppImage
|
||||
32
Makefile
32
Makefile
|
|
@ -1,19 +1,23 @@
|
|||
CXX=g++ -std=c++17
|
||||
CXXFLAGS+=-std=c++17
|
||||
OBJDIR=obj
|
||||
LIBDIR?=lib
|
||||
PREFIX=/usr
|
||||
HFILES:=$(shell find src/ -type f -iname *.h -print)
|
||||
CXXFILES:=$(shell find src/ -type f -iname *.cpp -print)
|
||||
GTKFLAGS:=$(shell pkg-config gtkmm-3.0 --cflags --libs)
|
||||
PKG_CONFIG?=pkg-config
|
||||
GTKFLAGS:=$(shell $(PKG_CONFIG) gtkmm-3.0 --cflags)
|
||||
GTKLIBS:=$(shell $(PKG_CONFIG) gtkmm-3.0 --libs)
|
||||
# For now, leave it to the distro to provide preferred extra flags
|
||||
CXXFLAGS+=$(GTKFLAGS) -Wall -lsteam_api -lcurl -lyajl -ldl
|
||||
CXXFLAGS+=$(GTKFLAGS) -Wall
|
||||
LDLIBS+=$(GTKLIBS) -lsteam_api -lcurl -lyajl -ldl
|
||||
LDFLAGS+=-L${CURDIR}/bin
|
||||
OBJS=$(addprefix ${OBJDIR}/,$(subst .cpp,.o,${CXXFILES}))
|
||||
|
||||
all: ${CURDIR}/bin/samrewritten
|
||||
@echo -e "==== Use '\033[1mmake dev\033[0m' to keep debug symbols"
|
||||
@echo -e "==== Use '\033[1mmake clean\033[0m' to remove object files"
|
||||
@echo -e "==== Nothing left to do."
|
||||
@printf "==== %b\n" \
|
||||
"Use '\033[1mmake dev\033[0m' to keep debug symbols" \
|
||||
"Use '\033[1mmake clean\033[0m' to remove object files" \
|
||||
"Nothing left to do."
|
||||
|
||||
dev: CXXFLAGS += -g -DDEBUG_CERR
|
||||
dev: ${CURDIR}/bin/samrewritten
|
||||
|
|
@ -24,13 +28,15 @@ clean:
|
|||
|
||||
.PHONY: install
|
||||
install: bin/launch.sh bin/samrewritten bin/libsteam_api.so
|
||||
# TODO: use install for all of these?
|
||||
mkdir -p ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/{bin,glade,assets}
|
||||
mkdir -p ${DESTDIR}${PREFIX}/share/icons/hicolor/{64x64,256x256}/apps
|
||||
mkdir -p ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/bin
|
||||
mkdir -p ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/glade
|
||||
mkdir -p ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/assets
|
||||
mkdir -p ${DESTDIR}${PREFIX}/share/icons/hicolor/64x64/apps
|
||||
mkdir -p ${DESTDIR}${PREFIX}/share/icons/hicolor/256x256/apps
|
||||
mkdir -p ${DESTDIR}${PREFIX}/share/applications
|
||||
mkdir -p ${DESTDIR}${PREFIX}/bin
|
||||
cp $^ ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/bin/
|
||||
ln -s ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/bin/launch.sh ${DESTDIR}${PREFIX}/bin/samrewritten
|
||||
ln -s ${PREFIX}/${LIBDIR}/SamRewritten/bin/launch.sh ${DESTDIR}${PREFIX}/bin/samrewritten
|
||||
cp glade/main_window.glade ${DESTDIR}${PREFIX}/${LIBDIR}/SamRewritten/glade/main_window.glade
|
||||
cp assets/icon_64.png ${DESTDIR}${PREFIX}/share/icons/hicolor/64x64/apps/samrewritten.png
|
||||
cp assets/icon_256.png ${DESTDIR}${PREFIX}/share/icons/hicolor/256x256/apps/samrewritten.png
|
||||
|
|
@ -38,8 +44,8 @@ install: bin/launch.sh bin/samrewritten bin/libsteam_api.so
|
|||
cp package/samrewritten.desktop ${DESTDIR}${PREFIX}/share/applications/
|
||||
|
||||
${CURDIR}/bin/samrewritten: $(OBJS)
|
||||
${CXX} -o ${CURDIR}/bin/samrewritten $(OBJS) ${LDFLAGS} ${CXXFLAGS}
|
||||
${CXX} -o ${CURDIR}/bin/samrewritten $(OBJS) ${LDFLAGS} ${CXXFLAGS} ${LDLIBS}
|
||||
|
||||
${OBJDIR}/%.o: %.cpp $(HFILES)
|
||||
@mkdir -p $$(dirname $@)
|
||||
$(CXX) -c -o $@ $< ${LDFLAGS} $(CXXFLAGS)
|
||||
@mkdir -p $(@D)
|
||||
$(CXX) -c -o $@ $< ${CXXFLAGS}
|
||||
|
|
|
|||
149
README.MD
149
README.MD
|
|
@ -1,149 +0,0 @@
|
|||
# SamRewritten
|
||||
A Steam Achievements Manager for Linux
|
||||
---
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/icon_256.png" alt="SamRewritten logo"/>
|
||||
</p>
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/screenshot.png" alt="SamRewritten screenshot"/>
|
||||
</p>
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/screenshot2.png" alt="SamRewritten screenshot"/>
|
||||
</p>
|
||||
|
||||
# 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!
|
||||
|
||||
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 :)
|
||||
|
||||
# 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.
|
||||
|
||||
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.
|
||||
|
||||
* **Ubuntu 18.04** and above: `$ sudo apt install libgtkmm-3.0-dev libcurl4-gnutls-dev libyajl-dev`
|
||||
|
||||
* **Arch** and variants: `$ sudo pacman -S gtkmm3 glibc gnutls yajl`
|
||||
|
||||
* **openSUSE** Tumbleweed, Leap 15.2+: `$ sudo zypper install gtkmm3 gcc-c++ gnutls libcurl-devel libyajl-devel-static`
|
||||
|
||||
* **Fedora 32+**: `$ sudo dnf install gtkmm30 gtkmm30-devel yajl-devel curl-devel g++`
|
||||
|
||||
To run SamRewritten, simply launch `$ ./bin/launch.sh`
|
||||
|
||||
## AUR Installation
|
||||
|
||||
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 following overlay:
|
||||
|
||||
https://github.com/telans/EBUILDS
|
||||
|
||||
# Features
|
||||
|
||||
SamRewritten's features match and exceed the original SAM:
|
||||
|
||||
* Ability to unlock/relock achievements and change stats
|
||||
* Asynchronous and cached icon downloads for games and achievements
|
||||
* Ability to select/deselect all achievements for locking/unlocking
|
||||
* Ability to search games, achievements, and stats and filter achievements by locked/unlocked
|
||||
* Ability to launch another SamRewritten instance for a game in a new window
|
||||
* Protected achievements and stats are detected
|
||||
* 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.
|
||||
|
||||
# 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.
|
||||
|
||||
```
|
||||
Usage:
|
||||
samrewritten [AppId] [OPTION...]
|
||||
|
||||
--apps Get the list of your owned apps.
|
||||
-h, --help Show CLI help.
|
||||
-a, --app arg Set which AppId you want to use. Same as using
|
||||
positional 'AppId'
|
||||
-i, --idle Set your Steam profile as 'ingame'. Ctrl+c to
|
||||
stop.
|
||||
--ls Display achievements and stats for selected app.
|
||||
--sort arg Sort option for --ls. You can leave empty or set
|
||||
to 'unlock_rate'
|
||||
--unlock arg Unlock achievements for an AppId. Separate
|
||||
achievement names by a comma.
|
||||
--lock arg Lock achievements for an AppId. Separate
|
||||
achievement names by a comma.
|
||||
--timed Do a timed achievement modification. Arguments
|
||||
that affect this are --amount, --units, --spacing,
|
||||
and --order
|
||||
--amount arg Control the amount of time spent for --timed
|
||||
modifications. Specify units with --units. Default
|
||||
is 1000
|
||||
--units arg Control the units of time spent for --timed
|
||||
modifications. Set to 'seconds', 'minutes', 'hours',
|
||||
or 'days'. Default is seconds
|
||||
--spacing arg Control the spacing between appying each
|
||||
modification for --timed modifications. Set to 'even' or
|
||||
'random'. Default is even
|
||||
--order arg Control the order --timed achievement
|
||||
modifications are applied in. Set to 'selection' or
|
||||
'random'. Default is selection
|
||||
--statnames arg Change stats for an AppId. Separate stat names
|
||||
by a comma. Use with statvalues to name the values
|
||||
in order
|
||||
--statvalues arg Change stats for an AppId. Separate stat values
|
||||
by a comma. Use with statnames to name the values
|
||||
in order
|
||||
-p, --launch_achievements Launch SamRewritten GUI and immediately switch
|
||||
to achievements page for the app.
|
||||
--launch Actually just launch the app.
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
|
||||
Change an achievement or stat value:
|
||||
|
||||
```
|
||||
# Find what you want from the --ls command for app id 54 (you can retrieve app ids from the store page URL).
|
||||
samrewritten 54 --ls
|
||||
|
||||
# Say we found achievements with IDs ach_500_kills and ach_found_something and stats stat_num_kills, stat_num_deaths
|
||||
# Modify them like this
|
||||
samrewritten 54 --unlock ach_500_kills,ach_found_something
|
||||
samrewritten 54 --statnames stat_num_kills,stat_num_deaths --statvalues 10,1
|
||||
```
|
||||
|
||||
Use the timed unlock on the commandline
|
||||
|
||||
```
|
||||
# Using the same achievements from the previous example
|
||||
samrewritten 54 --timed --unlock ach_500_kills,ach_found_something --amount 4 --units hours --spacing random --order random
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
## 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 responsability over your user experience
|
||||
175
README.md
Normal file
175
README.md
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
# SamRewritten
|
||||
|
||||
Legacy
|
||||
---
|
||||
|
||||
This is the legacy version of SamRewritten. It stood the test of time and should still work with modern Linux environments.
|
||||
|
||||
New developments and features are being developed on the new rewritten version: [SamRewritten](https://github.com/PaulCombal/SamRewritten)
|
||||
|
||||
The new version aims to:
|
||||
* Have a similar or wider support of Linux distributions
|
||||
* Have additional features
|
||||
* Display in a modern, revamped interface
|
||||
|
||||
If there is something this version can do the new can't, please let us know!
|
||||
|
||||
A Steam Achievements Manager for Linux
|
||||
---
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/icon_256.png" alt="SamRewritten logo"/>
|
||||
</p>
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/screenshot.png" alt="SamRewritten screenshot"/>
|
||||
</p>
|
||||
|
||||
<p align=center>
|
||||
<img src="assets/screenshot2.png" alt="SamRewritten screenshot"/>
|
||||
</p>
|
||||
|
||||
# Introduction
|
||||
|
||||
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!
|
||||
|
||||
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-legacy/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 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.
|
||||
|
||||
* **Ubuntu 18.04** and above: `$ sudo apt install libgtkmm-3.0-dev libcurl4-gnutls-dev libyajl-dev`
|
||||
|
||||
* **Arch** and variants: `$ sudo pacman -S gtkmm3 glibc gnutls yajl`
|
||||
|
||||
* **openSUSE** Tumbleweed, Leap 15.2+: `$ sudo zypper install gtkmm3 gcc-c++ gnutls libcurl-devel libyajl-devel-static`
|
||||
|
||||
* **Fedora 32+**: `$ sudo dnf install gtkmm30 gtkmm30-devel yajl-devel curl-devel g++`
|
||||
|
||||
|
||||
To run your SamRewritten build, use `$ ./bin/launch.sh`
|
||||
|
||||
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
|
||||
|
||||
SamRewritten's features match and exceed the original SAM:
|
||||
|
||||
* Ability to unlock/relock achievements and change stats
|
||||
* Asynchronous and cached icon downloads for games and achievements
|
||||
* Ability to select/deselect all achievements for locking/unlocking
|
||||
* Ability to search games, achievements, and stats and filter achievements by locked/unlocked
|
||||
* Ability to launch another SamRewritten instance for a game in a new window
|
||||
* Protected achievements and stats are detected
|
||||
* 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 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
|
||||
|
||||
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:
|
||||
samrewritten [AppId] [OPTION...]
|
||||
|
||||
--apps Get the list of your owned apps.
|
||||
-h, --help Show CLI help.
|
||||
-a, --app arg Set which AppId you want to use. Same as using
|
||||
positional 'AppId'.
|
||||
-i, --idle Set your Steam profile as 'ingame'. Ctrl+c to
|
||||
stop.
|
||||
--ls Display achievements and stats for selected app.
|
||||
--sort arg Sort option for --ls. You can leave empty or set
|
||||
to 'unlock_rate'.
|
||||
--filter-achieved arg Filter option for --ls. You can use with 'yes'/'y'
|
||||
or 'no'/'n' to only filter achived or not achieved ones.
|
||||
Default is all.
|
||||
--filter-protected arg Filter option for --ls. You can use with 'yes'/'y'
|
||||
or 'no'/'n' to only filter protected or not protected ones.
|
||||
Default is all.
|
||||
--nostats Do not displays stats after achievements.
|
||||
--unlock arg Unlock achievements for an AppId. Separate
|
||||
achievement names by a comma.
|
||||
--lock arg Lock achievements for an AppId. Separate
|
||||
achievement names by a comma.
|
||||
--timed Do a timed achievement modification. Arguments
|
||||
that affect this are --amount, --units, --spacing,
|
||||
and --order
|
||||
--amount arg Control the amount of time spent for --timed
|
||||
modifications. Specify units with --units. Default
|
||||
is 1000
|
||||
--units arg Control the units of time spent for --timed
|
||||
modifications. Set to 'seconds', 'minutes', 'hours',
|
||||
or 'days'. Default is seconds
|
||||
--spacing arg Control the spacing between appying each
|
||||
modification for --timed modifications. Set to 'even' or
|
||||
'random'. Default is even.
|
||||
--order arg Control the order --timed achievement
|
||||
modifications are applied in. Set to 'selection' or
|
||||
'random'. Default is selection.
|
||||
--timestamps Displays timestamps before time related information.
|
||||
--statnames arg Change stats for an AppId. Separate stat names
|
||||
by a comma. Use with statvalues to name the values
|
||||
in order.
|
||||
--statvalues arg Change stats for an AppId. Separate stat values
|
||||
by a comma. Use with statnames to name the values
|
||||
in order.
|
||||
-p, --launch_achievements Launch SamRewritten GUI and immediately switch
|
||||
to achievements page for the app.
|
||||
--launch Actually just launch the app.
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
|
||||
Change an achievement or stat value:
|
||||
|
||||
```
|
||||
# Find what you want from the --ls command for app id 54 (you can retrieve app ids from the store page URL).
|
||||
samrewritten 54 --ls
|
||||
|
||||
# Say we found achievements with IDs ach_500_kills and ach_found_something and stats stat_num_kills, stat_num_deaths
|
||||
# Modify them like this
|
||||
samrewritten 54 --unlock ach_500_kills,ach_found_something
|
||||
samrewritten 54 --statnames stat_num_kills,stat_num_deaths --statvalues 10,1
|
||||
```
|
||||
|
||||
Use the timed unlock on the commandline
|
||||
|
||||
```
|
||||
# Using the same achievements from the previous example
|
||||
samrewritten 54 --timed --unlock ach_500_kills,ach_found_something --amount 4 --units hours --spacing random --order random
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Third-party apps integration
|
||||
|
||||
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 [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 Steam ban using it, but we do not take any responsibility over your user experience.
|
||||
|
||||
SamRewritten includes third party libraries such as the Steam Steamworks SDK, which are subject to licensing by Valve Software.
|
||||
BIN
assets/funding-nano.jpeg
Normal file
BIN
assets/funding-nano.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
|
|
@ -1,10 +1,10 @@
|
|||
#!/bin/bash
|
||||
|
||||
SCRIPT_PATH=`dirname $(realpath $0)`
|
||||
SCRIPT_PATH=$(dirname "$(realpath "$0")")
|
||||
export LD_LIBRARY_PATH=${SCRIPT_PATH}
|
||||
|
||||
# Workaround waiting for a fix https://github.com/lloyd/yajl/issues/222
|
||||
export LC_NUMERIC=en_US.UTF-8
|
||||
|
||||
cd ${SCRIPT_PATH}/..
|
||||
${SCRIPT_PATH}/samrewritten $@
|
||||
cd "${SCRIPT_PATH}"/..
|
||||
"${SCRIPT_PATH}"/samrewritten "$@"
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
#!/bin/bash
|
||||
|
||||
SCRIPT_PATH=`dirname $(realpath $0)`
|
||||
SCRIPT_PATH=$(dirname "$(realpath "$0")")
|
||||
export LD_LIBRARY_PATH=${SCRIPT_PATH}
|
||||
|
||||
# Workaround waiting for a fix https://github.com/lloyd/yajl/issues/222
|
||||
export LC_NUMERIC=en_US.UTF-8
|
||||
|
||||
cd ${SCRIPT_PATH}/..
|
||||
cd "${SCRIPT_PATH}"/..
|
||||
rm -f /tmp/sam-massif.out
|
||||
valgrind --tool=massif --massif-out-file=/tmp/sam-massif.out ${SCRIPT_PATH}/samrewritten $@
|
||||
massif-visualizer /tmp/sam-massif.out
|
||||
massif-visualizer /tmp/sam-massif.out
|
||||
|
|
|
|||
109
doc/OVERVIEW.md
Normal file
109
doc/OVERVIEW.md
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
Overview of SamRewritten's internal logic
|
||||
===
|
||||
|
||||
This is technical documentation. The aim of this document is to provide the basic principles of the inner workings of SamRewritten to make it easier for new contributors to get started.
|
||||
|
||||
I (PaulCombal) will be referring to all the contributors of SamRewritten as "we", without whom this project would not have been complete. Thanks to all of you.
|
||||
|
||||
## Tools
|
||||
|
||||
SamRewritten is written in C++ exclusively.
|
||||
|
||||
It uses [GTKmm](https://gtkmm.org/) for the GUI. The designs have been created with the Gnome tool [Glade](https://glade.gnome.org/).
|
||||
|
||||
When building with `make dev`, SamRewritten's performance is monitored with [Valgrind](https://valgrind.org/), a tool used to profile resource usage. It results in the creation of massif files, which can be opened with different tools.
|
||||
|
||||
## Third-party libraries
|
||||
|
||||
For the command-line argument parsing, SamRewritten uses [cxxopts](https://github.com/jarro2783/cxxopts).
|
||||
|
||||
SamRewritten uses [yajl](https://lloyd.github.io/yajl/) for JSON serialization and deserialization internally.
|
||||
|
||||
To interface with Steam, SamRewritten uses Valve's Steamworks C++ SDK, available for download from [this page](https://partner.steamgames.com/doc/sdk). The file `bin/libsteam_api.so` as well as the folder `steam/` originate from this SDK.
|
||||
|
||||
For CLI output table formatting, SamRewritten uses [TextTable](https://github.com/haarcuba/cpp-text-table).
|
||||
|
||||
## Standard usage of Steamworks SDK
|
||||
|
||||
You can find here [the framework's documentation](https://partner.steamgames.com/doc/sdk/api). Please have a quick overview of it to understand the following paragraphs.
|
||||
|
||||
Usually, when making a app with the Steamworks SDK, one must call the function [`SteamAPI_Init`](https://partner.steamgames.com/doc/sdk/api#SteamAPI_Init) when booting the app in order to access all the features from the SDK afterwards. This will not only make the SDK usable, but also notify Steam that a Steam app was launched. In order for Steam to know which app has started, the Steam AppID must be set as the `SteamAppId` environment variable before executing the previously mentioned function.
|
||||
|
||||
The SDK is dynamically linked and uses functions from the shared object `libsteam_api.so`.
|
||||
|
||||
After testing, it has been found that Steam will only consider the game shut down when the calling process terminates (without leaving zombie processes).
|
||||
|
||||
To give a general idea of the purpose of the SDK, it includes functions such as:
|
||||
* to retrieve and set achievements & stats
|
||||
* to manipulate scoreboards
|
||||
* to check the ownership of DLCs and apps
|
||||
* get your in-game Steam avatar
|
||||
* etc.
|
||||
|
||||
## SamRewritten's way of retrieving owned apps
|
||||
|
||||
The Steamworks SDK provides an accessor `SteamClient()` to interface with Steam and use all the functionalities of the framework. However this accessor is not available unless [`SteamAPI_Init`](https://partner.steamgames.com/doc/sdk/api#SteamAPI_Init) has been called. We do not want to call this function yet, as we do not have any app to start. This is a problem.
|
||||
|
||||
There is a way around it. Steam comes with a shared object `steamclient.so`, which include Steam's signature for the Steam Client code. We will use it instead. This can be found in [`MySteamClient.h`](/src/controller/MySteamClient.h). This shared object *must* be loaded from the Steam installation directory of the local machine.
|
||||
|
||||
Now that we can access an [`ISteamClient`](https://partner.steamgames.com/doc/api/ISteamClient), we need to retrieve the game list of the current user. The only method at our disposal is `ISteamApps::BIsSubscribedApp`. As far as we know, there is no way to retrieve the list of owned apps and games.
|
||||
|
||||
That is why we started another project, which is to make a database of all apps on Steam with their AppID and name. The database can be created/updated with [this tool](https://github.com/PaulCombal/SteamAppsList), and the database itself is found [here](https://github.com/PaulCombal/SteamAppsListDumps). This database (which is really just a big JSON file) is seldom updated, feel free to help there too.
|
||||
|
||||
What happens is that SamRewritten downloads that list of apps and caches it, then tests for each app one by one if it is owned by the current user by calling `ISteamApps::BIsSubscribedApp`. The retrieval is implemented at [`SteamAppDAO.cpp#L60`](/src/controller/SteamAppDAO.cpp#L60). With this information we can deduce the user's app library.
|
||||
|
||||
While writing this documentation, I noticed a new interface [`ISteamAppList`](https://github.com/Facepunch/Facepunch.Steamworks/blob/master/Generator/steam_sdk/isteamapplist.h). Could this help?
|
||||
|
||||
## What happens when starting a game?
|
||||
|
||||
When starting a game, SamRewritten `fork`s, and the child process will follow the setup functions from the Steamworks SDK to act as if it were the selected game booting up. This is done by setting the environment variable `SteamAppId` and calling [`SteamAPI_Init`](https://partner.steamgames.com/doc/sdk/api#SteamAPI_Init), as every game should do. Basically, a child process is created, and it notifies Steam that an app started, as instructed in the documentation.
|
||||
|
||||
This can be observed in [`src/controller/GameServerManager`](/src/controller/GameServerManager.cpp).
|
||||
|
||||
Internally, the child process is called server, and the parent process, client (GUI side). They communicate via sockets.
|
||||
|
||||
## How is data transmitted between the UI and the server?
|
||||
|
||||
Both the client and server send JSON serialized data through a UNIX socket. Like traditional web technologies, only the client side initiates requests.
|
||||
|
||||
*This means that (with a bit of hacking) anyone can build his own frontend for SamRewritten.*
|
||||
|
||||
When building SamRewritten in `dev` mode, you can see in plain text the messages being exchanged in the console.
|
||||
|
||||
The (de)serialization implementation is found under [`src/json`](/src/json).
|
||||
|
||||
The socket implementation is found under [`src/sockets`](/src/sockets). The file names are explicit, except for for [`MyGameSocket`](/src/sockets/MyGameSocket.cpp), which also includes request processing, the "backend" logic behind SamRewritten.
|
||||
|
||||
## How does the server process retrieve achievements and stats data?
|
||||
|
||||
As mentioned above, [`MyGameSocket`](/src/sockets/MyGameSocket.cpp) is responsible for server logic. It implements much of the Steamworks SDK features, so to understand it fully, we encourage you to familiarize yourself with [the framework's documentation](https://partner.steamgames.com/doc/sdk/api).
|
||||
|
||||
If you spend more time looking at the implementation, you can see that something odd happening. Indeed, part of the achievement data is retrieved through the Steamworks API (legacy code), and the rest (as well as the stats) are retrieved through a ["schema parser"](/src/schema_parser). Indeed, some information about the achievements cannot be retrieved through Steamworks, like the achievement icon URL.
|
||||
|
||||
That is why we implemented a parser, that will explore Steam's internal cache files to retrieve additional information. Note that the relevant cache isn't always loaded until the app is started: we did not find a way around calling [`SteamAPI_Init`](https://partner.steamgames.com/doc/sdk/api#SteamAPI_Init) with reliable results.
|
||||
|
||||
This leaves us with two means of retrieving data: schema parsing and Steamworks API calls. This can be confusing. That is why in the future, we plan to remove API calls as much as possible and use schema parsing as much as possible, since this method allows the retrieval of all required data.
|
||||
|
||||
## How are stats and achievements updated?
|
||||
|
||||
Stats and achievements are updated as shown in the Steamworks SDK. The full process can be summed up as emulating the app, and using this emulated app to unlock achievements as the real app would.
|
||||
|
||||
The actual implementation can be found at [`MyGameSocket#L289`](/src/sockets/MyGameSocket.cpp#L289).
|
||||
|
||||
We can always wonder, is this bannable or detectable? Maybe, in any case we strongly advise avoiding VAC-enabled games, and as said in the README, the contributors are not responsible for any consequences on your usage of SamRewritten. It was written for fun, and educational purposes only (believe it or not).
|
||||
|
||||
## What's next?
|
||||
|
||||
I'm an old man now, I barely do gaming or programming anymore. Maybe I will again someday. In the meantime, please continue asking questions and opening issues. We will do our best to answer you and get us excited to contribute again.
|
||||
|
||||
You will notice, in the ["Projects"](https://github.com/PaulCombal/SamRewritten/projects/1) tab, a kanban with a few tasks. These are the next steps to make SamRewritten cleaner and better. If there are any priorities on this project, you can find them there.
|
||||
|
||||
## How can I contribute?
|
||||
|
||||
Please fork the project, commit the changes on your fork, then make a pull request to the `dev` branch. Please provide a description of your changes and why you did them. I can be stupid, so I may ask you questions about your code first, do not always expect to get things merged immediately. We will review your changes when we can!
|
||||
|
||||
## That's all?
|
||||
|
||||
Is there something that needs to be clarified? Please tell us!
|
||||
|
||||
Otherwise, happy coding!
|
||||
|
|
@ -1,20 +1,20 @@
|
|||
# Maintainer: telans <telans@protonmail.com>
|
||||
# Co-Maintainer: Simon Tas <simon.tas.st@gmail.com>
|
||||
|
||||
pkgname="samrewritten-git"
|
||||
_pkgname="SamRewritten"
|
||||
pkgname="samrewritten-legacy-git"
|
||||
_pkgname="SamRewritten-legacy"
|
||||
pkgver=r199.916d83d
|
||||
pkgrel=1
|
||||
pkgdesc="A Steam Achievement Manager For Linux."
|
||||
arch=("any")
|
||||
url="https://github.com/PaulCombal/SamRewritten"
|
||||
url="https://github.com/PaulCombal/SamRewritten-legacy"
|
||||
license=("GPL3")
|
||||
depends=("steam" "yajl" "gtkmm3" "glibc" "curl")
|
||||
optdepends=("zenity: error messages with style"
|
||||
"valgrind: for automated dev script"
|
||||
"massif-visualizer: for automated dev script")
|
||||
makedepends=("git" "make" "gcc>=9.0")
|
||||
source=("git+https://github.com/PaulCombal/SamRewritten.git")
|
||||
source=("git+https://github.com/PaulCombal/SamRewritten-legacy.git")
|
||||
sha256sums=("SKIP")
|
||||
|
||||
pkgver() {
|
||||
|
|
|
|||
|
|
@ -7,8 +7,12 @@ if [ ! -f ../bin/samrewritten ]; then
|
|||
popd
|
||||
fi
|
||||
|
||||
export LINUXDEPLOY="squashfs-root/usr/bin/linuxdeploy"
|
||||
|
||||
rm -rf AppDir
|
||||
./linuxdeploy-x86_64.AppImage --appdir AppDir
|
||||
chmod +x linuxdeploy-x86_64.AppImage
|
||||
./linuxdeploy-x86_64.AppImage --appimage-extract
|
||||
$LINUXDEPLOY --appdir AppDir
|
||||
grep -v Icon samrewritten.desktop > AppDir/myapp.desktop
|
||||
echo Icon=myapp >> AppDir/myapp.desktop
|
||||
cp ../assets/icon_256.png AppDir/myapp.png
|
||||
|
|
@ -29,4 +33,8 @@ cp ../bin/samrewritten AppDir/usr/bin
|
|||
cp ../bin/libsteam_api.so AppDir/usr/lib
|
||||
cp ../assets/icon_256.png AppDir/usr/assets/
|
||||
|
||||
LD_LIBRARY_PATH=AppDir/usr/lib ./linuxdeploy-x86_64.AppImage --appdir AppDir --output appimage
|
||||
LD_LIBRARY_PATH=AppDir/usr/lib $LINUXDEPLOY --appdir AppDir
|
||||
rm AppDir/usr/lib/libglib-2.0.so.0
|
||||
|
||||
$LINUXDEPLOY-plugin-appimage --appdir AppDir
|
||||
rm -rf squashfs-root
|
||||
|
|
|
|||
Binary file not shown.
694
src/cli/TextTable.h
Normal file
694
src/cli/TextTable.h
Normal file
|
|
@ -0,0 +1,694 @@
|
|||
/*
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <map>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#ifdef TEXTTABLE_ENCODE_MULTIBYTE_STRINGS
|
||||
#include <clocale>
|
||||
#ifndef TEXTTABLE_USE_EN_US_UTF8
|
||||
#define TEXTTABLE_USE_EN_US_UTF8
|
||||
#endif
|
||||
#endif
|
||||
|
||||
class TextTable {
|
||||
public:
|
||||
enum class Alignment { LEFT, RIGHT };
|
||||
typedef std::vector<std::string> Row;
|
||||
TextTable()
|
||||
: _horizontal('-'), _vertical('|'), _corner('+'), _has_ruler(true) {}
|
||||
|
||||
TextTable(char horizontal, char vertical, char corner)
|
||||
: _horizontal(horizontal), _vertical(vertical), _corner(corner),
|
||||
_has_ruler(true) {}
|
||||
|
||||
explicit TextTable(char vertical)
|
||||
: _horizontal('\0'), _vertical(vertical), _corner('\0'),
|
||||
_has_ruler(false) {}
|
||||
|
||||
void setAlignment(unsigned i, Alignment alignment) {
|
||||
_alignment[i] = alignment;
|
||||
}
|
||||
|
||||
Alignment alignment(unsigned i) const { return _alignment[i]; }
|
||||
|
||||
char vertical() const { return _vertical; }
|
||||
|
||||
char horizontal() const { return _horizontal; }
|
||||
|
||||
void add(const std::string& content) { _current.push_back(content); }
|
||||
|
||||
void endOfRow() {
|
||||
_rows.push_back(_current);
|
||||
_current.assign(0, "");
|
||||
}
|
||||
|
||||
template <typename Iterator> void addRow(Iterator begin, Iterator end) {
|
||||
for (auto i = begin; i != end; ++i) {
|
||||
add(*i);
|
||||
}
|
||||
endOfRow();
|
||||
}
|
||||
|
||||
template <typename Container> void addRow(const Container& container) {
|
||||
addRow(container.begin(), container.end());
|
||||
}
|
||||
|
||||
const std::vector<Row>& rows() const { return _rows; }
|
||||
|
||||
void setup() const {
|
||||
determineWidths();
|
||||
setupAlignment();
|
||||
}
|
||||
|
||||
std::string ruler() const {
|
||||
std::string result;
|
||||
result += _corner;
|
||||
for (auto width = _width.begin(); width != _width.end(); ++width) {
|
||||
result += repeat(*width, _horizontal);
|
||||
result += _corner;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
int width(unsigned i) const { return _width[i]; }
|
||||
|
||||
bool has_ruler() const { return _has_ruler; }
|
||||
|
||||
int correctDistance(const std::string& string_to_correct) const {
|
||||
return static_cast<int>(string_to_correct.size()) -
|
||||
static_cast<int>(glyphLength(string_to_correct));
|
||||
};
|
||||
|
||||
private:
|
||||
const char _horizontal;
|
||||
const char _vertical;
|
||||
const char _corner;
|
||||
const bool _has_ruler;
|
||||
Row _current;
|
||||
std::vector<Row> _rows;
|
||||
std::vector<unsigned> mutable _width;
|
||||
std::vector<unsigned> mutable _utf8width;
|
||||
std::map<unsigned, Alignment> mutable _alignment;
|
||||
|
||||
static std::string repeat(unsigned times, char c) {
|
||||
std::string result;
|
||||
for (; times > 0; --times)
|
||||
result += c;
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
unsigned columns() const { return _rows[0].size(); }
|
||||
|
||||
unsigned glyphLength(const std::string& s) const {
|
||||
unsigned int _byteLength = s.length();
|
||||
#ifdef TEXTTABLE_ENCODE_MULTIBYTE_STRINGS
|
||||
#ifdef TEXTTABLE_USE_EN_US_UTF8
|
||||
std::setlocale(LC_ALL, "en_US.utf8");
|
||||
#else
|
||||
#error You need to specify the encoding if the TextTable library uses multybyte string encoding!
|
||||
#endif
|
||||
unsigned int u = 0;
|
||||
const char *c_str = s.c_str();
|
||||
unsigned _glyphLength = 0;
|
||||
while (u < _byteLength) {
|
||||
u += std::mblen(&c_str[u], _byteLength - u);
|
||||
_glyphLength += 1;
|
||||
}
|
||||
return _glyphLength;
|
||||
#else
|
||||
return _byteLength;
|
||||
#endif
|
||||
}
|
||||
|
||||
void determineWidths() const {
|
||||
if (_rows.empty()) {
|
||||
return;
|
||||
}
|
||||
_width.assign(columns(), 0);
|
||||
_utf8width.assign(columns(), 0);
|
||||
for (auto rowIterator = _rows.begin(); rowIterator != _rows.end();
|
||||
++rowIterator) {
|
||||
Row const &row = *rowIterator;
|
||||
for (unsigned i = 0; i < row.size(); ++i) {
|
||||
_width[i] =
|
||||
_width[i] > glyphLength(row[i]) ? _width[i] : glyphLength(row[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void setupAlignment() const {
|
||||
if (_rows.empty()) {
|
||||
return;
|
||||
}
|
||||
for (unsigned i = 0; i < columns(); ++i) {
|
||||
if (_alignment.find(i) == _alignment.end()) {
|
||||
_alignment[i] = Alignment::LEFT;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
inline std::ostream &operator<<(std::ostream &stream, const TextTable& table) {
|
||||
if (table.rows().empty()) {
|
||||
return stream;
|
||||
}
|
||||
table.setup();
|
||||
if (table.has_ruler()) {
|
||||
stream << table.ruler() << "\n";
|
||||
}
|
||||
for (auto rowIterator = table.rows().begin();
|
||||
rowIterator != table.rows().end(); ++rowIterator) {
|
||||
TextTable::Row const &row = *rowIterator;
|
||||
stream << table.vertical();
|
||||
for (unsigned i = 0; i < row.size(); ++i) {
|
||||
auto alignment = table.alignment(i) == TextTable::Alignment::LEFT
|
||||
? std::left
|
||||
: std::right;
|
||||
// std::setw( width ) works as follows: a string which goes in the stream
|
||||
// with byte length (!) l is filled with n spaces so that l+n=width. For a
|
||||
// utf8 encoded string the glyph length g might be smaller than l. We need
|
||||
// n spaces so that g+n=width which is equivalent to g+n+l-l=width ==> l+n
|
||||
// = width+l-g l-g (that means glyph length minus byte length) has to be
|
||||
// added to the width argument. l-g is computed by correctDistance.
|
||||
stream << std::setw(table.width(i) + table.correctDistance(row[i]))
|
||||
<< alignment << row[i];
|
||||
stream << table.vertical();
|
||||
}
|
||||
stream << "\n";
|
||||
if (table.has_ruler()) {
|
||||
stream << table.ruler() << "\n";
|
||||
}
|
||||
}
|
||||
|
||||
return stream;
|
||||
}
|
||||
|
|
@ -3,17 +3,18 @@
|
|||
#include "../globals.h"
|
||||
#include "../common/cxxopts.hpp"
|
||||
#include "../common/functions.h"
|
||||
#include "TextTable.h"
|
||||
|
||||
#include <string>
|
||||
#include <iostream>
|
||||
#include <csignal>
|
||||
#include <thread>
|
||||
#include <unistd.h>
|
||||
#include <ctime>
|
||||
|
||||
void handle_sigint_cli(int signum)
|
||||
{
|
||||
std::cout << "Quitting cli idling" << std::endl;
|
||||
g_steam->quit_game();
|
||||
exit(EXIT_SUCCESS);
|
||||
}
|
||||
|
||||
|
|
@ -21,7 +22,13 @@ void idle_app(AppId_t appid)
|
|||
{
|
||||
std::cout << "Idling from command line " << appid << std::endl;
|
||||
g_steam->launch_app(appid);
|
||||
signal(SIGINT, handle_sigint_cli);
|
||||
struct sigaction sigIntHandler;
|
||||
|
||||
sigIntHandler.sa_handler = handle_sigint_cli;
|
||||
sigemptyset(&sigIntHandler.sa_mask);
|
||||
sigIntHandler.sa_flags = 0;
|
||||
|
||||
sigaction(SIGINT, &sigIntHandler, NULL);
|
||||
|
||||
// Wait for ctrl+c, so we can kill both processes, otherwise
|
||||
// GUI process will exit while game process still goes on
|
||||
|
|
@ -30,6 +37,12 @@ void idle_app(AppId_t appid)
|
|||
}
|
||||
}
|
||||
|
||||
char* current_time_as_string()
|
||||
{
|
||||
std::time_t now = std::time(nullptr);
|
||||
return std::asctime(std::localtime(&now));
|
||||
}
|
||||
|
||||
bool compareByUnlockRateDesc(const Achievement_t &a, const Achievement_t &b)
|
||||
{
|
||||
return a.global_achieved_rate > b.global_achieved_rate;
|
||||
|
|
@ -47,17 +60,21 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
("a,app", "Set which AppId you want to use. Same as using positional 'AppId'", cxxopts::value<AppId_t>())
|
||||
("i,idle", "Set your Steam profile as 'ingame'. Ctrl+c to stop.")
|
||||
("ls", "Display achievements and stats for selected app.")
|
||||
("filter-achieved", "Filter option for --ls. You can use with 'yes'/'y' or 'no'/'n' to only filter achived or not achieved ones", cxxopts::value<std::string>())
|
||||
("filter-protected", "Filter option for --ls. You can use with 'yes'/'y' or 'no'/'n' to only filter protected or not protected ones", cxxopts::value<std::string>())
|
||||
("sort", "Sort option for --ls. You can leave empty or set to 'unlock_rate'", cxxopts::value<std::string>())
|
||||
("unlock", "Unlock achievements for an AppId. Separate achievement names by a comma.", cxxopts::value<std::vector<std::string>>())
|
||||
("lock", "Lock achievements for an AppId. Separate achievement names by a comma.", cxxopts::value<std::vector<std::string>>())
|
||||
("timed", "Do a timed achievement modification. Arguments that affect this are --amount, --units, --spacing, and --order")
|
||||
("amount", "Control the amount of time spent for --timed modifications. Specify units with --units. Default is 1000", cxxopts::value<uint64_t>())
|
||||
("units", "Control the units of time spent for --timed modifications. Set to 'seconds', 'minutes', 'hours', or 'days'. Default is seconds", cxxopts::value<std::string>())
|
||||
("spacing", "Control the spacing between appying each modification for --timed modifications. Set to 'even' or 'random'. Default is even", cxxopts::value<std::string>())
|
||||
("spacing", "Control the spacing between appying each modification for --timed modifications. Set to 'even', 'evenish' or 'random'. Default is even", cxxopts::value<std::string>())
|
||||
("order", "Control the order --timed achievement modifications are applied in. Set to 'selection' or 'random'. Default is selection", cxxopts::value<std::string>())
|
||||
("statnames", "Change stats for an AppId. Separate stat names by a comma. Use with statvalues to name the values in order", cxxopts::value<std::vector<std::string>>())
|
||||
("statvalues", "Change stats for an AppId. Separate stat values by a comma. Use with statnames to name the values in order", cxxopts::value<std::vector<std::string>>())
|
||||
("p,launch_achievements", "Launch SamRewritten GUI and immediately switch to achievements page for the app.") // This is used by the GUI for launching in a new window
|
||||
("nostats", "Do not display stats")
|
||||
("timestamps", "Display timestamps on time related information")
|
||||
("launch", "Actually just launch the app.");
|
||||
|
||||
options.parse_positional({"app"});
|
||||
|
|
@ -121,6 +138,9 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
return true;
|
||||
}
|
||||
|
||||
MODIFICATION_ACHIEVED mod_achieved = ACHIEVED_ALL;
|
||||
MODIFICATION_PROTECTED mod_protected = PROTECTED_ALL;
|
||||
|
||||
g_steam->launch_app(app);
|
||||
g_steam->refresh_achievements_and_stats();
|
||||
auto achievements = g_steam->get_achievements();
|
||||
|
|
@ -138,46 +158,106 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
}
|
||||
}
|
||||
|
||||
if (result.count("filter-achieved") > 0) {
|
||||
std::string achieved = result["filter-achieved"].as<std::string>();
|
||||
|
||||
// https://github.com/haarcuba/cpp-text-table -> worth? nah but best I've found
|
||||
std::cout << "API Name \t\tName \t\tDescription \t\tUnlock rate \t\tUnlocked \t\tProtected\n";
|
||||
std::cout << "--------------------------------------------------------------" << std::endl;
|
||||
if (achieved == "no" || achieved == "n") {
|
||||
mod_achieved = NOT_ACHIEVED;
|
||||
} else if (achieved == "yes" || achieved == "y") {
|
||||
mod_achieved = ACHIEVED;
|
||||
} else {
|
||||
std::cerr << "invalid filter-achieved value: " << mod_achieved << std::endl;
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
mod_achieved = ACHIEVED_ALL;
|
||||
}
|
||||
|
||||
if (result.count("filter-protected") > 0) {
|
||||
std::string ach_protected = result["filter-protected"].as<std::string>();
|
||||
|
||||
if (ach_protected == "no" || ach_protected == "n") {
|
||||
mod_protected = NOT_PROTECTED;
|
||||
} else if (ach_protected == "yes" || ach_protected == "y") {
|
||||
mod_protected = PROTECTED;
|
||||
} else {
|
||||
std::cerr << "invalid filter-protected value: " << mod_protected << std::endl;
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
mod_protected = PROTECTED_ALL;
|
||||
}
|
||||
|
||||
std::cout << "ACHIEVEMENTS" << std::endl;
|
||||
TextTable t(' ');
|
||||
t.add("API Name");
|
||||
t.add("Name");
|
||||
t.add("Description");
|
||||
t.add("Unlock rate");
|
||||
if (mod_achieved == ACHIEVED_ALL)
|
||||
t.add("Unlocked");
|
||||
if (mod_protected == PROTECTED_ALL)
|
||||
t.add("Protected");
|
||||
t.endOfRow();
|
||||
for ( Achievement_t& achievement : achievements )
|
||||
{
|
||||
std::cout
|
||||
<< achievement.id << " \t"
|
||||
<< achievement.name << " \t"
|
||||
<< achievement.desc << " \t"
|
||||
<< achievement.global_achieved_rate << "% \t"
|
||||
<< (achievement.achieved ? "✔️" : "❌") << " \t"
|
||||
<< (is_permission_protected(achievement.permission) ? "Yes" : "No") << std::endl;
|
||||
if (achievement.achieved && mod_achieved == NOT_ACHIEVED)
|
||||
continue;
|
||||
else if (!achievement.achieved && mod_achieved == ACHIEVED)
|
||||
continue;
|
||||
if (is_permission_protected(achievement.permission) && mod_protected == NOT_PROTECTED)
|
||||
continue;
|
||||
else if (!is_permission_protected(achievement.permission) && mod_protected == PROTECTED)
|
||||
continue;
|
||||
t.add(achievement.id);
|
||||
t.add(achievement.name);
|
||||
t.add(achievement.desc);
|
||||
t.add(std::to_string(achievement.global_achieved_rate) + '%');
|
||||
if (mod_achieved == ACHIEVED_ALL)
|
||||
t.add(achievement.achieved ? "✅" : "❌");
|
||||
if (mod_protected == PROTECTED_ALL)
|
||||
t.add(is_permission_protected(achievement.permission) ? "Yes" : "No");
|
||||
t.endOfRow();
|
||||
}
|
||||
|
||||
std::cout << std::endl;
|
||||
|
||||
if ( stats.size() == 0 )
|
||||
{
|
||||
std::cout << "No stats found for this app.." << std::endl;
|
||||
}
|
||||
else
|
||||
{
|
||||
std::cout << "\nSTATS\n";
|
||||
std::cout << "API Name \t\tType \t\t Value \t\tIncrement Only \t\tProtected\n";
|
||||
std::cout << "----------------------------------------" << std::endl;
|
||||
for (auto stat : stats )
|
||||
t.endOfRow();
|
||||
t.setAlignment(2, TextTable::Alignment::LEFT);
|
||||
std::cout << t << std::endl;
|
||||
if (result.count("nostats") == 0) {
|
||||
if ( stats.size() == 0 )
|
||||
{
|
||||
std::cout << stat.id << " \t";
|
||||
std::cout << "No stats found for this app..." << std::endl;
|
||||
}
|
||||
else
|
||||
{
|
||||
std::cout << "STATS" << std::endl;
|
||||
TextTable t(' ');
|
||||
t.add("API Name");
|
||||
t.add("Type");
|
||||
t.add("Value");
|
||||
t.add("Increment Only");
|
||||
t.add("Protected");
|
||||
t.endOfRow();
|
||||
for (auto stat : stats )
|
||||
{
|
||||
t.add(stat.id);
|
||||
if (stat.type == UserStatType::Integer) {
|
||||
t.add("Integer");
|
||||
t.add(std::to_string(std::any_cast<long long>(stat.value)));
|
||||
} else if (stat.type == UserStatType::Float) {
|
||||
t.add("Float");
|
||||
t.add(std::to_string(std::any_cast<double>(stat.value)));
|
||||
} else {
|
||||
t.add("Unknown");
|
||||
t.add("Unknown");
|
||||
}
|
||||
|
||||
if (stat.type == UserStatType::Integer) {
|
||||
std::cout << "Integer \t" << std::to_string(std::any_cast<long long>(stat.value)) << " \t";
|
||||
} else if (stat.type == UserStatType::Float) {
|
||||
std::cout << "Float \t" << std::to_string(std::any_cast<double>(stat.value)) << " \t";
|
||||
} else {
|
||||
std::cout << "Unknown \tUnknown \t";
|
||||
t.add(stat.incrementonly ? "Yes" : "No");
|
||||
t.add(is_permission_protected(stat.permission) ? "Yes" : "No");
|
||||
t.endOfRow();
|
||||
}
|
||||
|
||||
std::cout << (stat.incrementonly ? "Yes" : "No") << " \t"
|
||||
<< (is_permission_protected(stat.permission) ? "Yes" : "No") << std::endl;
|
||||
t.setAlignment(2, TextTable::Alignment::LEFT);
|
||||
std::cout << t << std::endl;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
|
|
@ -221,7 +301,13 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
if (result.count("timed") > 0) {
|
||||
// Hook this up since we'll probably be in this function for a while
|
||||
// Really we could hook this up whenever we launch the app...
|
||||
signal(SIGINT, handle_sigint_cli);
|
||||
struct sigaction sigIntHandler;
|
||||
|
||||
sigIntHandler.sa_handler = handle_sigint_cli;
|
||||
sigemptyset(&sigIntHandler.sa_mask);
|
||||
sigIntHandler.sa_flags = 0;
|
||||
|
||||
sigaction(SIGINT, &sigIntHandler, NULL);
|
||||
|
||||
if (app == 0)
|
||||
{
|
||||
|
|
@ -232,6 +318,7 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
uint64_t time = 1000;
|
||||
MODIFICATION_SPACING spacing = EVEN_SPACING;
|
||||
MODIFICATION_ORDER order = SELECTION_ORDER;
|
||||
bool show_timestamp = result.count("timestamps") > 0;
|
||||
|
||||
if (result.count("amount") > 0) {
|
||||
time = result["amount"].as<uint64_t>();
|
||||
|
|
@ -261,6 +348,8 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
spacing = EVEN_SPACING;
|
||||
} else if (spacing_input == "random") {
|
||||
spacing = RANDOM_SPACING;
|
||||
} else if (spacing_input == "evenish") {
|
||||
spacing = EVEN_FREE_SPACING;
|
||||
} else {
|
||||
std::cerr << "invalid spacing: " << spacing_input << std::endl;
|
||||
return true;
|
||||
|
|
@ -281,13 +370,18 @@ bool go_cli_mode(int argc, char* argv[], AppId_t *return_app_id) {
|
|||
}
|
||||
|
||||
g_steam->launch_app(app);
|
||||
if (show_timestamp)
|
||||
std::cout << current_time_as_string();
|
||||
std::vector<uint64_t> times = g_steam->setup_timed_modifications(time, spacing, order);
|
||||
|
||||
while (!times.empty()) {
|
||||
if (show_timestamp)
|
||||
std::cout << current_time_as_string();
|
||||
std::cout << "Modifying next achievement in " << times[0] << " seconds"
|
||||
<< " (or " << (((double)times[0]) / 60) << " minutes or "
|
||||
<< ((((double)times[0]) / 60) / 60) << " hours)" << std::endl;
|
||||
std::this_thread::sleep_for(std::chrono::seconds(times[0]));
|
||||
g_steam->commit_next_timed_modification();
|
||||
times.erase(times.begin());
|
||||
}
|
||||
g_steam->quit_game();
|
||||
|
|
|
|||
|
|
@ -347,6 +347,13 @@ MySteam::setup_timed_modifications(uint64_t seconds, MODIFICATION_SPACING spacin
|
|||
{
|
||||
if (spacing == EVEN_SPACING) {
|
||||
times.push_back((i + 1) * (seconds / size));
|
||||
} else if (spacing == EVEN_FREE_SPACING) {
|
||||
uint64_t time = (i + 1) * (seconds / size);
|
||||
bool positive = rand() % 2;
|
||||
int sign = 1;
|
||||
if (!positive)
|
||||
sign = -1;
|
||||
times.push_back(time + sign*(((((double)rand()) / RAND_MAX))*time*0.1));
|
||||
} else {
|
||||
times.push_back(seconds * (((double)rand()) / RAND_MAX));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@
|
|||
enum MODIFICATION_SPACING {
|
||||
EVEN_SPACING = 0,
|
||||
RANDOM_SPACING = 1,
|
||||
EVEN_FREE_SPACING = 2,
|
||||
};
|
||||
|
||||
enum MODIFICATION_ORDER {
|
||||
|
|
@ -18,6 +19,18 @@ enum MODIFICATION_ORDER {
|
|||
RANDOM_ORDER = 1,
|
||||
};
|
||||
|
||||
enum MODIFICATION_ACHIEVED {
|
||||
ACHIEVED = 0,
|
||||
NOT_ACHIEVED = 1,
|
||||
ACHIEVED_ALL = 2,
|
||||
};
|
||||
|
||||
enum MODIFICATION_PROTECTED {
|
||||
PROTECTED = 0,
|
||||
NOT_PROTECTED = 1,
|
||||
PROTECTED_ALL = 2,
|
||||
};
|
||||
|
||||
/**
|
||||
* MySteam is the highest-level class of the program. Use it to
|
||||
* fake launch games, request unlocks, get icons, etc.
|
||||
|
|
@ -210,4 +223,4 @@ private:
|
|||
|
||||
std::vector<AchievementChange_t> m_achievement_changes;
|
||||
std::vector<StatChange_t> m_stat_changes;
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -25,6 +25,9 @@ AchievementBoxRow::AchievementBoxRow(const Achievement_t& data)
|
|||
button_icon_name = data.achieved ? ACH_BOX_ROW_ICON_UNLOCKED : ACH_BOX_ROW_ICON_LOCKED;
|
||||
escaped_name = data.name;
|
||||
escape_html(escaped_name);
|
||||
if (escaped_name.length() > 80) {
|
||||
escaped_name = escaped_name.substr(0,77) + "...";
|
||||
}
|
||||
ach_title_text = "<b>" + escaped_name + "</b>";
|
||||
char tmpbuf[16];
|
||||
snprintf(tmpbuf, 16, "%.1f", data.global_achieved_rate);
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@
|
|||
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <fstream>
|
||||
#include <iostream>
|
||||
#include <vector>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
// Mix them with bitwise operators
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user