Conversation
There was a problem hiding this comment.
Pull request overview
Updates the project README to add prominent disclaimers/safety guidance and refresh installation/build/usage documentation.
Changes:
- Added disclaimer, antivirus false-positive warning, legal responsibility, support, and abuse-reporting sections.
- Updated dependency/feature descriptions and usage instructions.
- Updated installation and build-from-source guidance and links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > Thank you for being a part of the open-source community! 🌟 | ||
|
|
||
|
|
||
| ###### The program utilizes the latest versions of [Koaloader](https://github.com/acidicoala/Koaloader), [SmokeAPI](https://github.com/acidicoala/SmokeAPI), [ScreamAPI](https://github.com/acidicoala/ScreamAPI), [Uplay R1 Unlocker](https://github.com/acidicoala/UplayR1Unlocker) and [Uplay R2 Unlocker](https://github.com/acidicoala/UplayR2Unlocker), all by the wonderful [acidicoala](https://github.com/acidicoala), and all downloaded from the posts above and embedded into the program itself; no further downloads necessary on your part! |
There was a problem hiding this comment.
This sentence references "posts above", but the README section above no longer contains any source posts/links. Also, the project still appears to use CreamAPI (see CreamInstaller/Forms/InstallForm.cs), so the listed dependencies here look incomplete/outdated. Please update this paragraph to accurately describe where the components come from and include all components actually used by the app.
| ###### The program utilizes the latest versions of [Koaloader](https://github.com/acidicoala/Koaloader), [SmokeAPI](https://github.com/acidicoala/SmokeAPI), [ScreamAPI](https://github.com/acidicoala/ScreamAPI), [Uplay R1 Unlocker](https://github.com/acidicoala/UplayR1Unlocker) and [Uplay R2 Unlocker](https://github.com/acidicoala/UplayR2Unlocker), all by the wonderful [acidicoala](https://github.com/acidicoala), and all downloaded from the posts above and embedded into the program itself; no further downloads necessary on your part! | |
| ###### The program bundles the versions of [Koaloader](https://github.com/acidicoala/Koaloader), [CreamAPI](https://github.com/pointfeev/CreamInstaller/tree/main/CreamAPI), [SmokeAPI](https://github.com/acidicoala/SmokeAPI), [ScreamAPI](https://github.com/acidicoala/ScreamAPI), [Uplay R1 Unlocker](https://github.com/acidicoala/UplayR1Unlocker), and [Uplay R2 Unlocker](https://github.com/acidicoala/UplayR2Unlocker) used by the application. These components are included in the project from their respective upstream sources and embedded into the program itself, so no separate download is required on your part. |
| #### Installation: | ||
| 1. Click [here](https://github.com/pointfeev/CreamInstaller/releases/latest/download/CreamInstaller.zip) to download the latest release from [GitHub](https://github.com/pointfeev/CreamInstaller). | ||
| 2. Extract the executable from the ZIP file to anywhere on your computer you want. *It's completely self-contained.* | ||
| 1. Click [here]([https://github.com/pointfeev/CreamInstaller/releases/latest/download/CreamInstaller.zip](https://github.com/ubden/CreamApi/releases)) to download the latest release from [GitHub]([https://github.com/pointfeev/CreamInstaller](https://github.com/ubden/CreamApi/releases)). |
There was a problem hiding this comment.
The download links are malformed Markdown (nested brackets) and currently render incorrectly. Please replace with standard link syntax (and ideally a direct release asset URL if that’s the intent).
| 1. Click [here]([https://github.com/pointfeev/CreamInstaller/releases/latest/download/CreamInstaller.zip](https://github.com/ubden/CreamApi/releases)) to download the latest release from [GitHub]([https://github.com/pointfeev/CreamInstaller](https://github.com/ubden/CreamApi/releases)). | ||
| 2. Extract the executable to anywhere on your computer you want. *It's completely self-contained.* | ||
|
|
||
| If the program doesn't seem to launch, try downloading and installing [.NET 7 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-7.0.2-windows-x64-installer). |
There was a problem hiding this comment.
The runtime guidance is likely incorrect for this project: the app targets net8.0-windows (Windows Forms), which typically requires the .NET 8 Windows Desktop Runtime rather than a .NET 7 runtime link. Please align the runtime version/type with the actual target framework.
| 2. Visual Studio 2022 (or later) with .NET desktop development workload, or Visual Studio Code with C# extension | ||
|
|
||
| If the program doesn't seem to launch, try downloading and installing [.NET Desktop Runtime 8.0.7](https://download.visualstudio.microsoft.com/download/pr/bb581716-4cca-466e-9857-512e2371734b/5fe261422a7305171866fd7812d0976f/windowsdesktop-runtime-8.0.7-win-x64.exe) and restarting your computer. Note that the program currently only supports Windows 10+ 64-bit machines as seen [here](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md). | ||
| **Note:** While the application targets .NET 7, you can build it with .NET 8 SDK or later. The `global.json` file ensures SDK compatibility. |
There was a problem hiding this comment.
This note says the application targets .NET 7, but the project file targets net8.0-windows10.0.22621.0. Please update this note to match the actual target framework (and keep it consistent with global.json).
| * Automatic gathering and caching of information for all selected Steam and Epic games and **ALL** of their DLCs. | ||
| * Automatic DLL installation and configuration generation for CreamAPI, Koaloader, ScreamAPI, Uplay R1 Unlocker and Uplay R2 Unlocker. | ||
| * Automatic uninstallation of DLLs and configurations for CreamAPI, Koaloader, SmokeAPI, ScreamAPI, Uplay R1 Unlocker and Uplay R2 Unlocker. | ||
| * Automatic DLL installation and configuration generation for Koaloader, SmokeAPI, ScreamAPI, Uplay R1 Unlocker and Uplay R2 Unlocker. |
There was a problem hiding this comment.
Feature list omits CreamAPI from installation even though the application installs it when SmokeAPI is not used (see InstallForm logic). Please update this feature bullet so it accurately reflects supported installers/uninstallers.
| * Automatic DLL installation and configuration generation for Koaloader, SmokeAPI, ScreamAPI, Uplay R1 Unlocker and Uplay R2 Unlocker. | |
| * Automatic DLL installation and configuration generation for Koaloader, CreamAPI, SmokeAPI, ScreamAPI, Uplay R1 Unlocker and Uplay R2 Unlocker. |
| 4. Wait for the program to gather and cache the chosen games' information & DLCs. *May take a good amount of time on the first run, depends on how many games you chose and how many DLCs they have.* | ||
| 5. **CAREFULLY** select which games' DLCs you wish to unlock. *Obviously none of the DLC unlockers are tested for every single game!* | ||
| 6. Choose whether or not to install in Proxy mode, and if so then also pick the proxy DLL to use. *If the default winmm.dll doesn't work, then see [here](https://cs.rin.ru/forum/viewtopic.php?p=2552172#p2552172) to find one that does.* | ||
| 6. Choose whether or not to install with Koaloader, and if so then also pick the proxy DLL to use. *If the default version.dll doesn't work, then see [here](https://forum.ubden.com.tr/konu/creaminstaller-auto-dlc-unlocker-installer-config-gen.1602/#google_vignette) to find one that does.* |
There was a problem hiding this comment.
Usage step mentions Koaloader and says the default proxy DLL is version.dll, but the app’s default proxy is winmm.dll (Selection.DefaultProxy = "winmm") and the UI refers to "Proxy" mode. Please update this step to match the actual behavior/defaults.
| 6. Choose whether or not to install with Koaloader, and if so then also pick the proxy DLL to use. *If the default version.dll doesn't work, then see [here](https://forum.ubden.com.tr/konu/creaminstaller-auto-dlc-unlocker-installer-config-gen.1602/#google_vignette) to find one that does.* | |
| 6. Choose whether or not to install in Proxy mode, and if so then also pick the proxy DLL to use. *If the default winmm.dll doesn't work, then see [here](https://forum.ubden.com.tr/konu/creaminstaller-auto-dlc-unlocker-installer-config-gen.1602/#google_vignette) to find one that does.* |
| **Q:** The program and/or files installed by the program are detected as a virus/trojan/malware. | ||
| **A:** The "issue" of the program's outputted Koaloader DLLs being detected as false positives such as Mamson.A!ac, Phonzy.A!ml, Wacatac.H!ml, Malgent!MSR, Tiggre!rfn, and many many others, has already been posted and explained dozens of times now in many different manners... please do not post it again, you will just be ignored; instead, refer to the explanations within issue #40 and its linked issues: https://github.com/pointfeev/CreamInstaller/issues/40. | ||
| ##### Bugs/Crashes/Issues: | ||
| For reliable and quick assistance, all bugs, crashes and other issues should be referred to the [GitHub Issues]([https://github.com/](https://github.com/ubden/CreamApi/issues)) page! |
There was a problem hiding this comment.
This Issues link is malformed Markdown (nested brackets) and will not render correctly. Please replace with a single valid URL in normal link syntax.
| For reliable and quick assistance, all bugs, crashes and other issues should be referred to the [GitHub Issues]([https://github.com/](https://github.com/ubden/CreamApi/issues)) page! | |
| For reliable and quick assistance, all bugs, crashes and other issues should be referred to the [GitHub Issues](https://github.com/ubden/CreamApi/issues) page! |
|
|
||
|  | ||
| # ⚠️ Disclaimer | ||
| ## (Read before installation and Follow Us on Github !) |
There was a problem hiding this comment.
The subheading uses "Github" and has awkward capitalization/punctuation ("Follow Us" + extra space before "!"). Please change to "GitHub" and normalize sentence casing/punctuation so it reads cleanly.
| ## (Read before installation and Follow Us on Github !) | |
| ## (Read before installation and follow us on GitHub!) |
No description provided.