Salastil/creamlinux
1
0
Fork 0
mirror of https://github.com/anticitizn/creamlinux.git synced 2026-01-24 21:42:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
D. Neykov
2023-04-03 17:44:07 +02:00
parent 67a7703c3f
commit 26eae1eec4
1 changed files with 14 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -4,40 +4,37 @@ 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
This should work for any linux native steam title that doesn't block LD_PRELOAD. This *should* work for any linux native steam title that doesn't block LD_PRELOAD. The following games have been tested and confirmed to work:
## Tested games
- Hearts Of Iron IV - Hearts Of Iron IV
- Stellaris - Stellaris
- PAYDAY 2 - PAYDAY 2
## Usage # Usage
0. You will need the actual, **up-to-date** DLC files in the game. Creamlinux does 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. Launch the game and have fun! 4. Launch the 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. 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 # Building from source
### On Ubuntu 0. Ensure you have all build dependencies installed:
`build-essential` `gcc-multilib` `g++-multilib` `cmake` `git` - On Ubuntu: `build-essential` `gcc-multilib` `g++-multilib` `cmake` `git`
### On Arch: - On Arch: `base-devel` `multilib-devel` `cmake` `git`
`base-devel` `multilib-devel` `cmake` `git`
## Building from source 1. Clone the project:
1. Clone the project recursively:
``` ```
git clone https://github.com/20PercentRendered/creamlinux --recursive git clone https://github.com/anticitizn/creamlinux
``` ```
2. build the project with build.sh 2. Build the project:
``` ```
sh ./build.sh sh ./build.sh
``` ```
3. Copy `output` folder contents to the game folder. 3. Copy `output` folder contents to the game folder
4. 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%`
## 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.