Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lvcabral/brs-desktop
Roku device simulator as a desktop app (macOS, Windows and Linux)
https://github.com/lvcabral/brs-desktop
desktop electron-app emulator roku roku-development simulator
Last synced: 3 months ago
JSON representation
Roku device simulator as a desktop app (macOS, Windows and Linux)
- Host: GitHub
- URL: https://github.com/lvcabral/brs-desktop
- Owner: lvcabral
- License: mit
- Created: 2019-09-28T01:09:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T23:07:00.000Z (9 months ago)
- Last Synced: 2024-05-17T22:20:47.977Z (9 months ago)
- Topics: desktop, electron-app, emulator, roku, roku-development, simulator
- Language: JavaScript
- Homepage:
- Size: 42.8 MB
- Stars: 17
- Watchers: 5
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# BrightScript Simulator - Desktop Application
[](https://github.com/lvcabral/brs-desktop/actions/workflows/build.yml)
[](https://sonarcloud.io/summary/new_code?id=lvcabral_brs-emu-app)
[](https://sonarcloud.io/summary/new_code?id=lvcabral_brs-emu-app)
[](https://join.slack.com/t/rokudevelopers/shared_invite/zt-4vw7rg6v-NH46oY7hTktpRIBM_zGvwA)
This project was created to develop a _multi-platform desktop application_ for the **BrightScript Simulation Engine**, please visit the engine library repository and know all about the project history, features and limitations: http://github.com/lvcabral/brs-engine
The objective of this application is to extend the `brs-engine`, making it a full Roku device simulator, providing features such as:
- Web Installer (default port 80), allowing deploy of side-loaded apps and screenshots.
- ECP Service (default port 8060), that allows automation and data integration with external applications.
- ECP-2 Service (WebSockets), supporting the Roku mobile application to control the simulator.
- Telnet Server (port 8085), enabling remote Debugging.
- Customization of display, device model and information, controls and localization.
This way, the desktop simulator can be detected and handled by the [VS Code BrightScript Extension](https://marketplace.visualstudio.com/items?itemName=RokuCommunity.brightscript), and other development tools, as a real Roku device, for deploy and debugging. You can find the installers for this desktop application (for all platforms) at this repository [Releases](https://github.com/lvcabral/brs-desktop/releases) page.
## Documentation
Below you will find the links for the documentation of this project, how to use, build and contribute to the application.
### Application Architecture
- [Overview Diagram](docs/images/brs-desktop-architecture-overview.png)
### How to Use the Application
- [Menu Options](docs/how-to-use.md#menu-options)
- [Settings Screen](docs/how-to-use.md#settings-screen)
- [Command Line Options](docs/how-to-use.md#command-line-options)
- [Keyboard and Game Pad Control](docs/control-reference.md)
- [Remote Access Services](docs/remote-access.md)
### Contributing
- [How to build from source](docs/build-from-source.md)
- [How to contribute](docs/contributing.md)
### Changelog
- Click [here](CHANGELOG.md) to view the release changelog.
## Developer Links
- My website: [https://lvcabral.com](https://lvcabral.com)
- My threads: [@lvcabral](https://www.threads.net/@lvcabral)
- My Bluesky: [@lvcabral.com](https://bsky.app/profile/lvcabral.com)
- My twitter: [@lvcabral](https://twitter.com/lvcabral)
- My podcast: [PODebug Podcast](http://podebug.com)
- Check my other [GitHub repositories](https://github.com/lvcabral)
## License
Copyright © 2019-2024 Marcelo Lv Cabral. All rights reserved.
Licensed under [MIT](LICENSE) License.