remotegameplay
This project is designed to be an open source implementation for streaming desktop games using WebRTC
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.8%) to scientific vocabulary
Repository
This project is designed to be an open source implementation for streaming desktop games using WebRTC
Basic Info
Statistics
- Stars: 22
- Watchers: 2
- Forks: 5
- Open Issues: 3
- Releases: 1
Metadata Files
README.md
The aim of this project is develop a WebRTC screenshare designed for streaming video games and
accepting remote inputs.
There will be ansible instructions which can be executed inside into any virtual environment. This will
be a plugin which complements the project P2PRC
//: # ()
//: # ()
Testing with X-Plane 11
Laplace
Based on the fork: https://github.com/Akilan1999/laplace/tree/keyboard_mouse
Installation
Installation required to share keyboard and mouse
Currently, you can use Barrier KVM.
//: # ()
What is Barrier KVM?
Barrier is software that mimics the functionality of a KVM switch, which historically would allow you to use a single keyboard and mouse to control multiple computers by physically turning a dial on the box to switch the machine you're controlling at any given moment. Barrier does this in software, allowing you to tell it which machine to control by moving your mouse to the edge of the screen, or by using a keypress to switch focus to a different system.
Barrier KVM build status and links to install
|Platform |Build Status|
| --:|:-- |
|Linux ||
|Mac |
|
|Windows Debug |
|
|Windows Release|
|
|Snap |
|
Build from source
```bash
Install golang
https://go.dev/doc/install
Build
go build .
Configure (run only once)
./remotegaming -setconfig
Migrate (run only once)
./remotegaming -Migrate
The following are OR Based instruction.
You could start the server in either of
of the modes. (run every time you
would want to start a server)
Setting up based on the generated config
open config.json
{
"SystemUsername": "
Both Servers
Starts the remote gaming screenshare server and the gameserver
./remotegaming -BothServers
Start only game server
./remotegaming -GameServer
Start only screenshare
./remotegaming -tls -headless ```
Starting game when screen-share is triggered
This requires creating a bash script to trigger when the screenshare begins.
Ex: Start X-Plane 11
Let's call this script xplane11.sh
```bash
Navigating to the directory where X-Plane11 is present
cd /path/.local/share/Steam/steamapps/common/X-Plane\ 11/
Execute X-Plane 11 binary
./X-Plane-x86_64 ```
//: # ()
//: # ()
//: # ()
//: # ()
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
or
Owner
- Name: Akilan Selvacoumar
- Login: Akilan1999
- Kind: user
- Location: Edinburgh, Scotland, United Kingdom
- Company: Maman LLC and Peernet
- Website: akilan.io
- Twitter: RealAkilan
- Repositories: 67
- Profile: https://github.com/Akilan1999
The not boring developer
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Selvacoumar" given-names: "Akilan" title: "remotegameplay" version: 1.0.0 date-released: 2021-09-04 url: "https://github.com/Akilan1999/remotegameplay"
GitHub Events
Total
- Watch event: 2
- Push event: 8
Last Year
- Watch event: 2
- Push event: 8
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 90
- Total Committers: 4
- Avg Commits per committer: 22.5
- Development Distribution Score (DDS): 0.2
Top Committers
| Name | Commits | |
|---|---|---|
| Akilan | me@a****o | 72 |
| Akilan Selvacoumar | 3****9@u****m | 8 |
| Gaurav Gosain | i****n@g****m | 6 |
| CSK | 7****7@u****m | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: almost 3 years ago
All Time
- Total issues: 3
- Total pull requests: 4
- Average time to close issues: N/A
- Average time to close pull requests: about 17 hours
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: about 9 hours
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Akilan1999 (3)
Pull Request Authors
- cr2007 (2)
- Akilan1999 (1)
- Gaurav-Gosain (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 2
proxy.golang.org: github.com/akilan1999/remotegameplay
- Documentation: https://pkg.go.dev/github.com/akilan1999/remotegameplay#section-documentation
- License: mit
-
Latest release: v1.0.0
published almost 5 years ago
Rankings
proxy.golang.org: github.com/Akilan1999/remotegameplay
- Homepage: https://github.com/Akilan1999/remotegameplay
- Documentation: https://pkg.go.dev/github.com/Akilan1999/remotegameplay#section-documentation
- License: MIT
-
Latest release: v1.0.0
published almost 5 years ago
Rankings
Dependencies
- github.com/gorilla/websocket v1.4.2
- github.com/spf13/viper v1.8.1
- 559 dependencies
- dorowu/ubuntu-desktop-lxde-vnc latest build