Skip to content

Commit

Permalink
merge dev into main (#1)
Browse files Browse the repository at this point in the history
* initial release v0.1-windows

* Updated Readme.md, fixed GPG signing by adding noreply email to key.

* General cleanup and v0.1 release.

* add precompiled windows binary

Signed-off-by: Defirence <[email protected]>
  • Loading branch information
Defirence authored Apr 18, 2022
1 parent 77a7662 commit 16dc15a
Show file tree
Hide file tree
Showing 7 changed files with 148 additions and 1 deletion.
77 changes: 76 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,76 @@
# custom-steam-status
# custom-steam-status

### ***Easy to use "custom status" for Steam***

---
### **Purpose**:

Takes a custom `.bat` file/script which uses the `IEXPRESS` script to compile an exe, which can be added as a non-Steam game to display a "custom status message" so to speak.

### **Requirements**:

Requires zero dependencies or knowledge of Batch scripting although this would help.

DOS, OS/2, MS Windows (3.1 Minimum) or an environment capable of creating, reading, compiling and running `.bat` and `.exe` files. (N.B: Not tested on anything below Windows 11 - )

If you're using anything above DOS, Win98, Me, XP, Vista or 7, 8 and 10 this will work too.

Makes use of npocmaka's IEXPRESS script:
https://github.com/npocmaka/batch.scripts/edit/master/hybrids/iexpress/bat2exeIEXP.bat

### **Cloning + Building from Source**:
HTTPS: `git clone https://github.com/Defirence/custom-steam-status.git`

SSH: `git clone [email protected]:Defirence/custom-steam-status.git`

### **Usage**:

`bat2exeIEXP.bat custom-steam-status.bat title-shown-on-steam.exe`

The compiled .exe will be stored in the current working directory, the status message displayed on Steam is determined by the name of the .exe file.

You're welcome to also download the pre-compiled .exe file from Releases. Although it's preferable you compile from source for better trust and security since you should never trust pre-compiled .exe files from anywhere, even if the source looks trustworthy.

The reason behind adding the pre-compiled .exe file is to make it easier for people unfamiliar with building from source, scripting, git cloning etc... to use this software.

I personally would rather not include the pre-compiled .exe, since it discourages learning, but I do understand not everyone is as technically-minded as myself or most others are with software and development.

### **Adding exe file to Steam**:

Navigate to the top menu bar -> `Games` -> `Add a non-steam game to my library`

Find the directory where you stored the compiled or downloaded .exe file and add it.

Once you have located and selected the .exe file, select `"Add selected programs"`.

Click the `"Play"` button to start the program and display the "custom" status message and minimize the `cmd` window that pops up.

### **Caveats**:

No option to minimize this to the notification tray.

Open an Issue or PR to get this added if it's *really* needed, otherwise for now it will be considered for a future version or release.

Can be run while playing VAC-protected games, but completely untested against other clients (EAC, PB etc..)

### **Media Types**:

* application/bat
* application/x-bat
* application/x-msdos-program
* text/plain

##### Adapted from: [Wikipedia - Batch file](https://en.wikipedia.org/wiki/Batch_file)

### **Licences**:
custom-steam-status: No Licence.

npocmaka's IEXPRESS: MIT Licence from original Repository.

### **Screenshots**:

![Compiling the exe file](/custom-steam-status/images/compile.webp)

![Adding the exe file](/custom-steam-status/images/add.webp)

![Running the exe file](/custom-steam-status/images/run.webp)
59 changes: 59 additions & 0 deletions bat2exeIEXP.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
;@echo off
; rem https://github.com/npocmaka/batch.scripts/edit/master/hybrids/iexpress/bat2exeIEXP.bat
;if "%~2" equ "" (
; echo usage: %~nx0 batFile.bat target.Exe
;)
;set "target.exe=%__cd__%%~2"
;set "batch_file=%~f1"
;set "bat_name=%~nx1"
;set "bat_dir=%~dp1"

;copy /y "%~f0" "%temp%\2exe.sed" >nul

;(echo()>>"%temp%\2exe.sed"
;(echo(AppLaunched=cmd.exe /c "%bat_name%")>>"%temp%\2exe.sed"
;(echo(TargetName=%target.exe%)>>"%temp%\2exe.sed"
;(echo(FILE0="%bat_name%")>>"%temp%\2exe.sed"
;(echo([SourceFiles])>>"%temp%\2exe.sed"
;(echo(SourceFiles0=%bat_dir%)>>"%temp%\2exe.sed"
;(echo([SourceFiles0])>>"%temp%\2exe.sed"
;(echo(%%FILE0%%=)>>"%temp%\2exe.sed"


;iexpress /n /q /m %temp%\2exe.sed

;rem del /q /f "%temp%\2exe.sed"
; exit /b 0

[Version]
Class=IEXPRESS
SEDVersion=3
[Options]
PackagePurpose=InstallApp
ShowInstallProgramWindow=0
HideExtractAnimation=1
UseLongFileName=1
InsideCompressed=0
CAB_FixedSize=0
CAB_ResvCodeSigning=0
RebootMode=N
InstallPrompt=%InstallPrompt%
DisplayLicense=%DisplayLicense%
FinishMessage=%FinishMessage%
TargetName=%TargetName%
FriendlyName=%FriendlyName%
AppLaunched=%AppLaunched%
PostInstallCmd=%PostInstallCmd%
AdminQuietInstCmd=%AdminQuietInstCmd%
UserQuietInstCmd=%UserQuietInstCmd%
SourceFiles=SourceFiles

[Strings]
InstallPrompt=
DisplayLicense=
FinishMessage=
FriendlyName=-
PostInstallCmd=<None>
AdminQuietInstCmd=
UserQuietInstCmd=
;
Binary file added bin/custom-steam-status-v0_1.exe
Binary file not shown.
13 changes: 13 additions & 0 deletions custom-steam-status.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
:: custom-steam-status v0.1
:: Licence: None
:: Creator: github.com/Defirence gitlab.com/Defirence
:: Uses npocmaka's IEXPRESS script:
:: Licence: MIT
:: https://github.com/npocmaka/batch.scripts/edit/master/hybrids/iexpress/bat2exeIEXP.bat
@echo off
echo custom-steam-status v0.1 running and displaying message in Steam...
echo You may minimize this window safely and run this in the background.
echo You may leave this running while playing a game, VAC safe, but untested against other anti-cheats.
echo THIS IS PROVIDED AS-IS WITHOUT SUPPORT OR LICENCE.
echo YOU ARE USING THIS AT YOUR OWN RISK, NO PARTIES WILL BE HELD LIABLE FOR ANY DAMAGES, BANS OR ET CETERA...
PAUSE
Binary file added images/add.webp
Binary file not shown.
Binary file added images/compile.webp
Binary file not shown.
Binary file added images/run.webp
Binary file not shown.

0 comments on commit 16dc15a

Please sign in to comment.