Skip to content

Latest commit

 

History

History
104 lines (64 loc) · 2.76 KB

README.md

File metadata and controls

104 lines (64 loc) · 2.76 KB
Raw

Xbox-Smartglass-Nano

PyPi version Docs Build status Discord chat

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

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.

  1. Fork the xbox-smartglass-nano-python repo on GitHub.
  2. Clone your fork locally
git clone [email protected]:your_name_here/xbox-smartglass-nano-python.git
  1. 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]
  1. Create a branch for local development::
git checkout -b name-of-your-bugfix-or-feature

  1. Make your changes.

  2. Before pushing the changes to git, please verify they actually work

pytest
  1. 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
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. Code includes unit-tests.
  2. Added code is properly named and documented.
  3. On major changes the README is updated.
  4. Run tests / linting locally before pushing to remote.

Credits

This package uses parts of Cookiecutter and the audreyr/cookiecutter-pypackage project template