Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added information to ReadMe #70

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/controller_profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/moondeck_launch_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 49 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,62 @@
# MoonDeck ![Status](https://github.com/FrogTheFrog/moondeck/actions/workflows/build.yaml/badge.svg) [![Chat](https://img.shields.io/badge/Chat-on%20discord-7289da.svg)](https://discord.com/invite/U88fbeHyzt) ![Decky store](https://img.shields.io/badge/dynamic/json?color=blue&label=Decky%20version&query=%24%5B%3F%28%40.name%3D%3D%27MoonDeck%27%29%5D.versions%5B0%5D.name&url=https%3A%2F%2Fplugins.deckbrew.xyz%2Fplugins)
# ***MOONDECK*** ![Status](https://github.com/FrogTheFrog/moondeck/actions/workflows/build.yaml/badge.svg) [![Chat](https://img.shields.io/badge/Chat-on%20discord-7289da.svg)](https://discord.com/invite/U88fbeHyzt) ![Decky store](https://img.shields.io/badge/dynamic/json?color=blue&label=Decky%20version&query=%24%5B%3F%28%40.name%3D%3D%27MoonDeck%27%29%5D.versions%5B0%5D.name&url=https%3A%2F%2Fplugins.deckbrew.xyz%2Fplugins)

A plugin that lets you play any of your Steam games via Moonlight without needing to add them to Sunshine first, providing a similar experience to GeForce GameStream or Steam Remote Play.

![quicksettings](.github/assets/quickmenu.png)

## What is it really?

MoonDeck is an automation tool that will simplify launching your Steam games via the Moonlight client for streaming.
***MOONDECK*** is an automation tool that will simplify launching your Steam games via the Moonlight client for streaming. It simplifies the launch of a specific game to a single click, similar to how Steam's Remote Play feature works.

It requires an additional lightweight app to be installed on the host PC - [MoonDeck Buddy](https://github.com/FrogTheFrog/moondeck-buddy). Additional one-time setup instructions can be found within the settings page of the plugin itself.

## Why would I need it?
***Game streaming via Moonlight, by DEFAULT, follows these steps:***

1. Open moonlight as an application on the steam deck
2. Select a Host machine to stream from
3. Select an application to stream, usually steam Big Picture Mode (BPM)
5. Select a game via BPM interface
AwkwaBear marked this conversation as resolved.
Show resolved Hide resolved
6. Selected Game is launched

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too many newlines everywhere, please keep to minimum required by MD.


***Game Streaming via MOONDECK follows these steps:***
1. Press ***MOONDECK*** button on game to stream within SteamDeck's OS
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should not use SteamDeck's OS, just Steam or something. This plugin works on other handhelds that use Bazzite.

2. Selected Game is launched via moonlight stream

![applicationLaunch](.github/assets/moondeck_launch_button.png)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots should not contain any other plugins in order to avoid confusion as users sometimes start asking pointless question like "why is this missing?"


***MOONDECK*** sets configurations ahead of time and skipping many of the steps each time a stream is started. This allows a streamlined experience of selecting a game directly from the steam deck's OS and immediately starting the game stream.


**More importantly, the ***Moonlight, by DEFAULT,*** method caused SteamDeck's OS to ONLY see *Moonlight* as the running application, rather than *any specific game*.**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it very hard to read when it's italic and bold, especially when italic is mixed withing bold style sentences.

Please avoid bold sentences and use only bold to empathize something (not bold+italic). For example:

**MOONDECK** sets configurations ahead of time and skipping many of the steps each time a stream is started.
More importantly, the **Moonlight, by DEFAULT,** method caused SteamDeck's OS to ONLY see **Moonlight** as the running application, rather than **any specific game**.

**This created a few problems, such as:**



- game-specific community controller profiles cannot detect the currently streamed game, preventing them from being downloaded or viewed
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially I also though this would be a good idea, but I no longer think you should use the controller profiles unless they are for generic controller (which SteamDeck is not). Please read this https://discord.com/channels/960281551428522045/1050462209689518201/1309261646467960884 and a few messages below.

- controller settings are tied to the overall *Moonlight* application, requiring manual reconfiguration when switching between streamed games
- performance profiles are linked to the *Moonlight* application, also requiring manual reconfiguration when switching between streamed games
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are these performance profiles?

- steam game guides for a streamed game cannot be found


***MOONDECK*** **fixes this issue by adding a button to each game within the Steamdeck's OS to launch directly into a moonlight stream with ***Steam's specific game title ID #*** associated for the running application in SteamDeck's OS.**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would really like to avoid having this point highlighted as a MoonDeck feature. It is a very hacky solution that apparently no longer works for some users and I have always contemplated about removing it altogether.



The result is that per streamed game ***community controller profiles automatically associate, can be downloaded, and modified*** and ***performance profiles via the QAM can be created, saved, and modified***


![controllerProfile](.github/assets/controller_profile.png)


**Note: Unfortunately, steam game guides are not working yet**



---
# For Devs


## Building

1. Clone this repo to the `~/homebrew/plugins`.
Expand Down