Update README.md

This commit is contained in:
D. Neykov
2023-04-03 17:35:55 +02:00
committed by GitHub
parent 553dc2462b
commit 67a7703c3f

View File

@@ -1,5 +1,6 @@
# Creamlinux # Creamlinux
CreamApi clone for Linux. A CreamAPI clone for Linux.
Since 20PercentRendered has archived the repo, I have decided to fork and support it as far as I can. Since 20PercentRendered has archived the repo, I have decided to fork and support it as far as I can.
## Support ## Support
@@ -11,16 +12,17 @@ This should work for any linux native steam title that doesn't block LD_PRELOAD.
- PAYDAY 2 - PAYDAY 2
## Usage ## Usage
0. You will need the actual, **up-to-date** DLC files in the game. Creamlinux does not and _will not_ auto-download anything. 0. You will need the actual, **up-to-date** DLC files in the game. Creamlinux does not auto-download anything.
1. Download the [latest](https://github.com/anticitizn/creamlinux/releases/latest/download/creamlinux.zip) release of Creamlinux. 1. Download the [latest](https://github.com/anticitizn/creamlinux/releases/latest/download/creamlinux.zip) release of Creamlinux.
2. Unzip it and copy the files to the game's directory 2. Unzip it and copy the files to the game's directory
3. Set the game's steam launch params to `sh ./cream.sh %command%`. 3. Set the game's steam launch params to `sh ./cream.sh %command%`.
4. If you have your own cream_api.ini, copy the DLC lines to Creamlinux's cream_api.ini in the game directory. 4. Launch the game and have fun!
5. Launch your game and have fun!
The list of "supported" DLCs is stored in `cream_api.ini`. If you want to test creamlinux on a new game or a new DLC has just come out, you can add more entries here manually.
## Build Dependencies ## Build Dependencies
### On Ubuntu ### On Ubuntu
`gcc-multilib` `g++-multilib` `cmake` `git` `build-essential` `gcc-multilib` `g++-multilib` `cmake` `git`
### On Arch: ### On Arch:
`base-devel` `multilib-devel` `cmake` `git` `base-devel` `multilib-devel` `cmake` `git`
@@ -35,11 +37,11 @@ sh ./build.sh
``` ```
3. Copy `output` folder contents to the game folder. 3. Copy `output` folder contents to the game folder.
4. Then set the game's steam launch params to `sh ./cream.sh %command%`. 4. Set the game's steam launch params to `sh ./cream.sh %command%`.
5. If you have your own cream_api.ini, copy the DLC lines to Creamlinux's cream_api.ini in the game directory.
## Advanced
## Advanced
If you want to load `cream_api.ini` from a specific path, specify the path with `CREAM_CONFIG_PATH` in the launch options. If you want to load `cream_api.ini` from a specific path, specify the path with `CREAM_CONFIG_PATH` in the launch options.
## Todo ## Todo
- Proxy mode - Proxy mode
- Support for some older versions of the steam API - Support for some older versions of the steam API