mirror of
https://github.com/Novattz/creamlinux-installer.git
synced 2026-01-30 07:12:51 -05:00
refactor: complete UI overhaul and add SmokeAPI support
This commit is contained in:
45
README.md
45
README.md
@@ -1,33 +1,44 @@
|
||||
|
||||
# Steam DLC Fetcher and installer for Linux
|
||||
- Python script designed for linux to automate fetching of DLC id's for steam games and the installation of creamlinux automatically. [Demo/Tutorial](https://www.youtube.com/watch?v=Y1E15rUsdDw)
|
||||
- A user-friendly tool for managing DLC for Steam games on Linux systems.
|
||||
|
||||
[Demo/Tutorial](https://www.youtube.com/watch?v=Y1E15rUsdDw) - [OUTDATED]
|
||||
|
||||
### Features
|
||||
- Automatically fetches and lists DLC's for selected steam game(s) installed on the computer.
|
||||
- Automatically installs creamlinux and its components into selected steam games, excluding and handling specific config files.
|
||||
- Provides a simple cli to navigate and operate the entire process.
|
||||
- Automatic Steam library detection
|
||||
- Support for Linux and Proton
|
||||
- Automatic updates (Soon)
|
||||
- DLC detection and installation
|
||||
|
||||
## Usage
|
||||
### Prerequisites
|
||||
- `python 3.x`
|
||||
- `requests` library
|
||||
- `zipfile` library
|
||||
- `tqdm` >=4.65.0
|
||||
|
||||
- Python 3.7 or higher
|
||||
- requests
|
||||
- rich
|
||||
- argparse
|
||||
- json
|
||||
|
||||
### Installation
|
||||
|
||||
- Clone the repo or download the script.
|
||||
- Navigate to the directory containing the script.
|
||||
- Run the script using python.
|
||||
|
||||
#### OR
|
||||
Use this one-line shell script.
|
||||
- Run the script using python:
|
||||
```bash
|
||||
git clone https://github.com/Novattz/creamlinux-installer;cd creamlinux-installer;python dlc_fetcher.py
|
||||
python main.py
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
- `--manual <path>`: Specify steam library path manually
|
||||
```bash
|
||||
python main.py --manual "/path/to/steamapps"
|
||||
```
|
||||
- `--debug`: Enable debug logging
|
||||
```bash
|
||||
python main.py --debug
|
||||
```
|
||||
|
||||
### Issues?
|
||||
- Open a issue and attach all relevant errors/logs.
|
||||
|
||||
# Credits
|
||||
- [All credits for creamlinux go to its original author and contributors.](https://github.com/anticitizn/creamlinux)
|
||||
## Credits
|
||||
- [Creamlinux](https://github.com/anticitizn/creamlinux) by anticitizn
|
||||
- [SmokeAPI](https://github.com/acidicoala/SmokeAPI) by acidicoala
|
||||
|
||||
Reference in New Issue
Block a user