Salastil/creamlinux
1
0
Fork 0
mirror of https://github.com/anticitizn/creamlinux.git synced 2025-12-05 21:15:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add some troubleshooting tips and alternatives to creamlinux to readme

Browse Source
This commit is contained in:
Daniel Neykov
2025-04-14 10:34:35 +02:00
committed by GitHub
parent 2256c2e45b
commit bf2d1a285d
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -4,9 +4,8 @@ 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 native Linux Steam title that doesn't block LD_PRELOAD. It does not work with Proton or Wine - use SmokeAPI or other alternatives made specifically for Windows instead. Creamlinux *should* work on most Steam games. It does not work with Proton or Wine - use SmokeAPI or other alternatives made specifically for Windows instead.
The following games have been tested and definitely confirmed to work:
The following games have been tested and confirmed to work:
- Stellaris - Stellaris
- Hearts Of Iron IV - Hearts Of Iron IV
@@ -15,6 +14,11 @@ The following games have been tested and confirmed to work:
- Crusader Kings III - Crusader Kings III
- PAYDAY 2 - PAYDAY 2
## Unsupported Games
The following games have been tested and do not currently work with creamlinux, feel free to try some of the alternatives listed at the bottom of this readme:
- Cities Skylines 2
- European Truck Simulator / American Truck Simulator
## Installation ## Installation
The easiest way of installing is using **Novattz**'s Python script: https://github.com/Novattz/creamlinux-installer The easiest way of installing is using **Novattz**'s Python script: https://github.com/Novattz/creamlinux-installer
It automatically downloads and sets up creamlinux for Steam games that you choose, as well as fetching all DLC IDs for it. Keep in mind that you will still need the actual, **up-to-date** DLC files in the game. The install script and creamlinux do **not** automatically download any game content. You will have to run it again if new DLCs are released for a game. It automatically downloads and sets up creamlinux for Steam games that you choose, as well as fetching all DLC IDs for it. Keep in mind that you will still need the actual, **up-to-date** DLC files in the game. The install script and creamlinux do **not** automatically download any game content. You will have to run it again if new DLCs are released for a game.
@@ -58,7 +62,8 @@ This is normal. The DLCs should still work.
![Red triangles next to DLCs are normal](https://cdn.discordapp.com/attachments/663174968791662594/1093109044295766106/image.png) ![Red triangles next to DLCs are normal](https://cdn.discordapp.com/attachments/663174968791662594/1093109044295766106/image.png)
## DLCs don't work ## DLCs don't work
Have you made sure to download the latest version of the DLC files? Sometimes unrelated patches or updates to the game will modify some DLC files, and creamlinux is currently somewhat sensitive to outdated files. - Have you made sure to download the latest version of the DLC files? Sometimes unrelated patches or updates to the game will modify some DLC files, and creamlinux is currently somewhat sensitive to outdated files.
- Do you have Steam installed from a flatpak? Creamlinux doesn't play nicely with it, please try a native version if possible
## Game not starting after enabling creamlinux ## Game not starting after enabling creamlinux
Are you sure that the creamlinux files are at the game's root directory and not in a subfolder? Are you sure that the creamlinux files are at the game's root directory and not in a subfolder?
@@ -70,6 +75,7 @@ chmod +x cream.sh
## It doesn't work with Proton or Wine ## It doesn't work with Proton or Wine
Creamlinux is specifically made for native Linux games. If you are using a compatibility layer, use alternatives made specifically for Windows (e.g. SmokeAPI, regular CreamAPI or whatever). Creamlinux is specifically made for native Linux games. If you are using a compatibility layer, use alternatives made specifically for Windows (e.g. SmokeAPI, regular CreamAPI or whatever).
![AutoCreamAPI](https://github.com/MoebiusZero/AutoCreamAPI) has worked well for some people, keep in mind that you need to install .NetCore3 on your Wine/Proton instance first.
## Nothing helped! ## Nothing helped!
Please collect a log using the instructions below as well as an overview of the game's directory using `ls -lh; ls -lh */`, then post an issue describing your situation [here](https://github.com/anticitizn/creamlinux/issues/new). Please collect a log using the instructions below as well as an overview of the game's directory using `ls -lh; ls -lh */`, then post an issue describing your situation [here](https://github.com/anticitizn/creamlinux/issues/new).
@@ -84,12 +90,18 @@ Or if you are using Gnome environment, you can set your launch options to this:
gnome-terminal -- sh -c "./cream.sh %command%; exec bash" gnome-terminal -- sh -c "./cream.sh %command%; exec bash"
``` ```
If using neither, install `konsole` and follow the KDE step. If using neither, install `konsole` and follow the KDE step.
Then launch the game (skip any launchers like the Paradox launcher if possible, they interfere with the logging). Wait for the game to load if applicable, close it, then copy and paste the contents of the terminal. Then launch the game (skip any launchers like the Paradox launcher if possible, they interfere with the logging). Wait for the game to load, close it, then copy and paste the contents of the terminal.
# 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.
## Credits # Alternatives
If creamlinux doesn't work for your game, there are a couple of known alternatives for Linux. I provide no guarantees for their legitimacy and functionality, but some people seem to be happy with them.
- ![StellarKey](https://0xacab.org/stellarkey/stellarkey)
- ![CreamAPI (Windows, MacOS, Linux)[https://cs.rin.ru/forum/viewtopic.php?f=29&t=70576]
- ![AutoCreamAPI for Proton](https://github.com/MoebiusZero/AutoCreamAPI) (.NetCore3 required)
# Credits
The many contributors who submitted bugfixes, tested games and updated the list of DLC IDs :) The many contributors who submitted bugfixes, tested games and updated the list of DLC IDs :)
[Novattz](https://github.com/Novattz) for [creamlinux-installer](https://github.com/Novattz/creamlinux-installer) [Novattz](https://github.com/Novattz) for [creamlinux-installer](https://github.com/Novattz/creamlinux-installer)