Xbox-Smartglass-Nano
The gamestreaming part of the smartglass library, codename NANO.
Currently supported version:
- NANO v1 (Xbox One family)
XCloud and new XHome streaming are Nano v3, required for Xbox Series S/X.
For in-depth information, check out the documentation: (https://openxbox.github.io)
Features
- Stream from your local Xbox One (OG/S/X) console
Dependencies
- Python >= 3.7
- xbox-smartglass-core
- pyav (https://pyav.org/docs/develop/)
- pysdl2 (https://pysdl2.readthedocs.io/en/latest/install.html)
Install
pip install xbox-smartglass-nano
How to use
xbox-nano-client
Known issues
- Video / Audio / Input is not smooth yet
- ChatAudio and Input Feedback not implemented
Development workflow
Ready to contribute? Here's how to set up xbox-smartglass-nano-python for local development.
- Fork the
xbox-smartglass-nano-pythonrepo on GitHub. - Clone your fork locally
git clone [email protected]:your_name_here/xbox-smartglass-nano-python.git
- Install your local copy into a virtual environment. This is how you set up your fork for local development
python -m venv ~/pyvenv/xbox-smartglass
source ~/pyvenv/xbox-smartglass/bin/activate
cd xbox-smartglass-nano-python
pip install -e .[dev]
- Create a branch for local development::
git checkout -b name-of-your-bugfix-or-feature
-
Make your changes.
-
Before pushing the changes to git, please verify they actually work
pytest
- Commit your changes and push your branch to GitHub::
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
- Submit a pull request through the GitHub website.
Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
- Code includes unit-tests.
- Added code is properly named and documented.
- On major changes the README is updated.
- Run tests / linting locally before pushing to remote.
Credits
This package uses parts of Cookiecutter and the audreyr/cookiecutter-pypackage project template