auto-creamapi/README.md

69 lines
2.5 KiB
Markdown
Raw Normal View History

2019-11-20 09:50:01 -05:00
# Auto-CreamAPI
2019-11-15 14:05:26 -05:00
Set your game automatically up for use with CreamAPI.
2020-05-13 02:28:51 -04:00
![](https://jeddunk.xyz/javaw_nLB130vOCY.png)
2020-08-25 07:34:13 -04:00
[![](https://jeddunk.xyz/jetbrains-small.png)](https://www.jetbrains.com/?from=Auto-CreamAPI)
[Made with software provided by JetBrains s.r.o.](https://www.jetbrains.com/?from=Auto-CreamAPI)
2019-11-20 09:50:01 -05:00
## Features
* Setup CreamAPIs DLLs and configuration file automatically.
* Find the AppID by providing the games name without having to look it up manually.
* Fetch a list of DLCs for an AppID from both the Steam Store and SteamDB.
* Set flags like "offline mode" and "extra protection".
* Select a language from a list which can be manually expanded if needed.
2019-11-15 14:05:26 -05:00
## Installation
**Make sure you have Java 8 installed.**
2020-05-10 09:07:43 -04:00
Download the latest release and extract it into any folder (e.g. `%USERPROFILE%\Desktop\auto-cream-api`).
*The included CreamAPI version may be outdated, get the most recent version and
**extract the DLL files from the nonlog_build folder to the Auto-CreamAPI folder!***
2019-11-15 14:05:26 -05:00
## Usage
2020-05-10 09:07:43 -04:00
* Double-click `auto-cream-api.jar` to open the application. (When starting it for the first time, it might take a few
seconds since it needs to cache a list of games available on the Steam Store.)
2019-11-15 14:05:26 -05:00
* Alternatively, open a CMD window in the location of the application, and run it by entering the following:
```shell script
java -jar auto-cream-api.jar
```
* Click on the *Folder* (📂) button on the top right and select the *steam_api.dll* or *steam_api64.dll*
**in the game folder**.
* Enter the name of the game and click on the *Search* (🔍) button.
* If it did not find the right game, either try again, or copy the app ID from the Steam Store to field to the right
of the *Search* (🔍) button.
* Click the lower left *"Get DLCs for AppID"* button to fetch all available DLCs for the game.
* Select a language and tick the options if needed.
2020-06-10 14:10:50 -04:00
* Click on *"Save"*.
2020-10-14 07:43:29 -04:00
### Java 11/Java 14
2020-08-24 09:54:24 -04:00
*WIP*
2020-06-10 14:10:50 -04:00
## License
Auto-CreamAPI itself is licensed under the GNU General Public License v3.0
CreamAPI © 2016-2019, deadmau5. All Rights Reserved.
2020-08-24 09:54:24 -04:00
The following dependencies are licensed under the Apache License 2.0:
* JFoenix
* fontawesomefx
* gson
* Apache Commons BeanUtils
* Apache Commons Configuration
2020-10-14 07:46:43 -04:00
* The Roboto font family
2020-08-24 09:54:24 -04:00
The following dependencies are licensed under the MIT License:
* jsoup
* Unirest-Java
2020-10-14 07:43:29 -04:00
* slf4j
* Copy Rename Maven Plugin
The following dependencies are licensed under the GPL2 License:
* fuzzywuzzy
Logback is dual-licensed under the EPL v1.0 and the LGPL 2.1.