mirror of
https://github.com/moraroy/NonSteamLaunchers-On-Steam-Deck.git
synced 2024-12-21 07:11:52 +01:00
Update README.md
Fix some formatting/grammar. Add dev environment section
This commit is contained in:
pythoninthegrass
parent
a786689fcd
commit
8ccf3f1443
116
README.md
116
README.md
@ -2,12 +2,14 @@
|
||||
<p align="center">
|
||||
<img src="https://github.com/cchrkk/NSLOSD-DL/raw/main/logo.svg" width=40% height=auto
|
||||
</p>
|
||||
|
||||
<h1 align="center">
|
||||
NonSteamLaunchers 🚀
|
||||
</h1>
|
||||
|
||||
This script installs the latest GE-Proton, installs NonSteamLaunchers under one unique Proton prefix folder in your compatdata folder path called "NonSteamLaunchers" and adds them to your Steam Library.
|
||||
So you can use them on Desktop or in Game Mode.
|
||||
|
||||
<h1 align="center">
|
||||
Features ✅
|
||||
</h1>
|
||||
@ -54,10 +56,11 @@ Supported Streaming Sites for games and as well as any website. 🌐
|
||||
<h1 align="left">
|
||||
Find Games
|
||||
</h1>
|
||||
|
||||
Use the "Find Games" button to load [Boilr](https://github.com/PhilipK/BoilR) this will open Boilr for you to set your settings so you can find your games easier.
|
||||
|
||||
<h1 align="center">
|
||||
How to Install🔧
|
||||
How to Install 🔧
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
@ -65,11 +68,12 @@ How to Install🔧
|
||||
</p>
|
||||
<!--- Thanks https://github.com/Heus-Sueh -->
|
||||
|
||||
+ Go to desktop mode, right click the download button above and save the .desktop file to your Steam Deck desktop.
|
||||
+ Go to your desktop, click the NonSteamLaunchers icon, it will download and run the latest NonSteamLaunchers.sh from this repository and run it.
|
||||
+ You will simply have to choose which launcher to install and let the script handle the rest. 💻 No files are left in your "Downloads" they are deleted after installation.
|
||||
+ After running the script, launch Steam on your Steam Deck. You'll find the new launchers in your library under the non-steam tab. Click a launcher to see your installed games from that store, and launch them directly from Steam! Even in gamemode 🥳
|
||||
* Go to desktop mode, right click the download button above and save the .desktop file to your Steam Deck desktop.
|
||||
* Go to your desktop, click the NonSteamLaunchers icon, it will download and run the latest NonSteamLaunchers.sh from this repository and run it.
|
||||
* You will simply have to choose which launcher to install and let the script handle the rest. 💻 No files are left in your "Downloads" they are deleted after installation.
|
||||
* After running the script, launch Steam on your Steam Deck. You'll find the new launchers in your library under the non-steam tab. Click a launcher to see your installed games from that store, and launch them directly from Steam! Even in gamemode 🥳
|
||||
|
||||
<!--- TODO: handful of broken icons (cf. 🡺🡺🡺 ); probably should remove or replace them with more common font to handle unicode-->
|
||||
|
||||
<p align="center">
|
||||
▶️ YouTube Tutorial 🡺🡺🡺 https://www.youtube.com/watch?v=svOj4MTEAVc 🡸🡸🡸 ▶️
|
||||
@ -89,21 +93,111 @@ How to Uninstall 🗑
|
||||
Currently Working On 👷♂️
|
||||
</h1>
|
||||
|
||||
- Decky Loader Plugin ❌
|
||||
- Auto-download images and set them for library entries ❌
|
||||
- Integrate better with [BoilR](https://github.com/PhilipK/BoilR) ❌
|
||||
#
|
||||
* Decky Loader Plugin ❌
|
||||
* Auto-download images and set them for library entries ❌
|
||||
* Integrate better with [BoilR](https://github.com/PhilipK/BoilR) ❌
|
||||
|
||||
<h1 align="center">
|
||||
Contributing 🤝
|
||||
</h1>
|
||||
|
||||
If you have any suggestions or improvements for this script, feel free to open an issue or submit a pull request.
|
||||
You can donate me on [ko-fi](https://ko-fi.com/moraroy), [liberapay](https://liberapay.com/moraroy) or [sponsor me on github](https://github.com/sponsors/moraroy)
|
||||
|
||||
You can donate to me on [ko-fi](https://ko-fi.com/moraroy), [liberapay](https://liberapay.com/moraroy), or [sponsor me on github](https://github.com/sponsors/moraroy)
|
||||
|
||||
## Development Environment
|
||||
|
||||
### Dev Container
|
||||
|
||||
Install [Docker](https://docs.docker.com/compose/install/). Once installed, a clean dev environment with a Docker container [native to VSCode](https://code.visualstudio.com/docs/devcontainers/create-dev-container#_dockerfile) is spun up automatically.
|
||||
|
||||
* [Command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (⇧⌘P) > Dev Containers: Reopen in Container
|
||||
* F5 for debug
|
||||
* May need to select interpreter (e.g., `/opt/venv/bin/python`) first
|
||||
|
||||
**VSCode Extensions (Dev Container)**
|
||||
|
||||
* [Atom Keymap](https://marketplace.visualstudio.com/items?itemName=ms-vscode.atom-keybindings)
|
||||
* [Bash IDE](https://marketplace.visualstudio.com/items?itemName=mads-hartmann.bash-ide-vscode)
|
||||
* [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
|
||||
* [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker)
|
||||
* [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
||||
* [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
|
||||
* [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat)
|
||||
* [gitignore](https://marketplace.visualstudio.com/items?itemName=codezombiech.gitignore)
|
||||
* [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
|
||||
* [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
|
||||
* [MS Visual Studio Live Share](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare)
|
||||
* [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
||||
* [Shellcheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck)
|
||||
|
||||
### Manual Docker Instance
|
||||
|
||||
If VSCode isn't present or only the python portion (cf. `__init__.py`) is being worked on, it's possible to just run a Docker container on its own. The container installs the correct version of python and any dependencies (e.g., ipython, rich) in `requirements.txt`.
|
||||
|
||||
```bash
|
||||
# navigate to directory with Dockerfile
|
||||
cd .devcontainer/
|
||||
|
||||
# build image
|
||||
docker build -t nonsteamlaunchers .
|
||||
|
||||
# run container
|
||||
docker run -it --rm --name=mynonsteamlaunchers --workdir=/app -v $(pwd):/app nonsteamlaunchers bash
|
||||
|
||||
# exit container
|
||||
exit
|
||||
```
|
||||
|
||||
### Python virtual environment
|
||||
|
||||
Useful for the python module(s), but extra compared to the [dev container](#dev-container) portion that covers the core shell script.
|
||||
|
||||
```bash
|
||||
# create virtual environment
|
||||
python -m venv .venv
|
||||
|
||||
# activate virtual environment
|
||||
source .venv/bin/activate
|
||||
|
||||
# install dependencies
|
||||
python -m pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Additional tooling
|
||||
|
||||
Additional tooling includes but is not limited to:
|
||||
|
||||
#### asdf
|
||||
|
||||
* Install [asdf](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf)
|
||||
* Usage
|
||||
```bash
|
||||
# add python plugin
|
||||
asdf plugin-add python
|
||||
|
||||
# install stable python
|
||||
asdf install python <latest|3.11.4>
|
||||
|
||||
# set stable to system python
|
||||
asdf global python latest
|
||||
|
||||
# add poetry asdf plugin
|
||||
asdf plugin-add poetry https://github.com/asdf-community/asdf-poetry.git
|
||||
|
||||
# install latest version via asdf
|
||||
asdf install poetry <latest|1.5.1>
|
||||
|
||||
# set latest version as default
|
||||
asdf global poetry latest
|
||||
```
|
||||
|
||||
#### shellcheck
|
||||
|
||||
`.shellcheckrc` excludes various [bash language rules](https://github.com/koalaman/shellcheck/wiki/Ignore#ignoring-one-or-more-types-of-errors-forever). Useful to control noise vs. legitimate warnings/errors when using the shellcheck extension.
|
||||
|
||||
<h1 align="center">
|
||||
License 📝
|
||||
</h1>
|
||||
|
||||
|
||||
This project is licensed under the MIT License. See the `LICENSE` file for more information.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user