mirror of
https://github.com/zoffline/zwift-offline.git
synced 2026-08-03 09:21:33 -07:00
214 lines
10 KiB
Markdown
214 lines
10 KiB
Markdown
# zoffline
|
|
|
|
zoffline enables the use of [Zwift](http://zwift.com) offline by acting as a partial implementation
|
|
of a Zwift server. Currently it's designed for only a single user and the UDP
|
|
game node is not implemented.
|
|
|
|
## Install
|
|
|
|
Setting up zoffline requires two primary steps. First, zoffline must be installed and run on a system before running Zwift (either on the system running Zwift or on another locally networked system). Second, Zwift must be configured to use zoffline instead of the official Zwift server.
|
|
|
|
### Step 1: Install zoffline
|
|
There are three ways with which to install and run zoffline depending on your platform:
|
|
|
|
<details><summary>Simplest (Windows only)</summary>
|
|
To install zoffline on Windows:
|
|
|
|
* Download the latest zoffline release from https://github.com/zoffline/zwift-offline/releases
|
|
* Run the downloaded zoffline.exe
|
|
* Once run, zoffline will create a ``storage`` directory in the same folder it's in to store your Zwift progress.
|
|
* Start Zwift with zoffline.exe running (__after completing step 2__)
|
|
* It takes zoffline few seconds to start. Wait until text appears in the command prompt before opening Zwift.
|
|
* When done with Zwift, press Ctrl+C in the command line to close zoffline.
|
|
</details>
|
|
|
|
<details><summary>Linux, Windows, or Mac OS X</summary>
|
|
To install zoffline on Linux, Windows, or Mac OS X:
|
|
|
|
* Install Python 2 (https://www.python.org/downloads/) if not already installed
|
|
* Install dependencies: flask, python-protobuf, protobuf_to_dict, stravalib (optional)
|
|
* e.g., on Linux/Mac: ``pip install flask protobuf protobuf_to_dict stravalib``
|
|
* e.g., on Windows in command prompt: ``C:\Python27\Scripts\pip.exe install flask protobuf protobuf_to_dict stravalib``
|
|
* Clone or download this repo
|
|
* Run standalone.py before starting Zwift
|
|
* e.g., on Linux/Mac: ``sudo ./standalone.py``
|
|
* sudo is needed because we're binding to the privileged ports 80 and 443.
|
|
* e.g., on Windows in command prompt: ``C:\Python27\python.exe standalone.py``
|
|
* Start Zwift with standalone.py running (__after completing step 2__)
|
|
* Note: When upgrading zoffline, be sure to retain the ``storage`` directory. It contains your Zwift progress state.
|
|
|
|
zoffline can be installed on the same machine as Zwift or another local machine.
|
|
</details>
|
|
|
|
|
|
<details><summary>Using Docker (recommended for Linux)</summary>
|
|
|
|
* Install Docker
|
|
* Create the docker container with:<br>
|
|
``docker create --name zwift-offline -p 443:443 -p 80:80 -v </path/to/host/storage>:/usr/local/apache2/htdocs/zwift-offline/storage -e TZ=<timezone> zoffline/zoffline``
|
|
* You can optionally exclude ``-v </path/to/host/storage>:/usr/local/apache2/htdocs/zwift-offline/storage`` if you don't care if your Zwift progress state is retained across zoffline updates (unlikely).
|
|
* The path you pass to ``-v`` will likely need to be world readable and writable.
|
|
* A list of valid ``<timezone>`` values (e.g. America/New_York) can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
* Adding ``--restart unless-stopped`` will make zoffline start on boot if you have Docker v1.9.0 or greater.
|
|
* Start zoffline with:
|
|
``docker start zwift-offline``
|
|
|
|
If you don't use the Docker container you will need to set up an Apache server (or
|
|
write your own nginx/uWSGI configuration and use nginx) and install the
|
|
dependencies listed below. The necessary Apache configuration is inside the
|
|
``apache`` subdir.
|
|
</details>
|
|
|
|
|
|
### Step 2: Configure Zwift client to use zoffline
|
|
|
|
<details><summary>Windows 10 Instructions</summary>
|
|
|
|
* Install Zwift
|
|
* If your Zwift version is newer than 1.0.44368 you may have to uninstall, then reinstall after installing zoffline.
|
|
* If your Zwift version is 1.0.44368, you're all set.
|
|
* If Zwift is not installed install it after installing zoffline (1.0.44368 will be installed instead of the latest).
|
|
* On your Windows machine running Zwift, copy the following files in this repo to a known location:
|
|
* ``ssl/cert-zwift-com.p12``
|
|
* ``ssl/cert-zwift-com.pem``
|
|
* Open Command Prompt as an admin, cd to that location and run
|
|
* ``certutil.exe -importpfx Root cert-zwift-com.p12``
|
|
* If you're prompted for a password, just leave it blank. There is no password.
|
|
* Open Notepad as an admin and open ``C:\Program Files (x86)\Zwift\data\cacert.pem``
|
|
* Append the contents of ``ssl/cert-zwift-com.pem`` to cacert.pem
|
|
* Open Notepad as an admin and open ``C:\Windows\System32\Drivers\etc\hosts``
|
|
* Append this line: ``<zoffline ip> us-or-rly101.zwift.com secure.zwift.com cdn.zwift.com``
|
|
<br />(Where ``<zoffline ip>`` is the ip address of the machine running zoffline. If
|
|
it's running on the same machine as Zwift, use ``127.0.0.1`` as the ip.)
|
|
|
|
Why: We need to redirect Zwift to use zoffline and convince Windows and Zwift to
|
|
accept zoffline's self signed certificates for Zwift's domain names. Feel free
|
|
to generate your own certificates and do the same.
|
|
|
|
</details>
|
|
|
|
<details><summary>Mac OS X Instructions (Thanks @oldnapalm!)</summary>
|
|
|
|
* Install Zwift
|
|
* If your Zwift version is newer than 1.0.44368 you may have to uninstall, then reinstall after installing zoffline.
|
|
* If your Zwift version is 1.0.44368, you're all set.
|
|
* If Zwift is not installed install it after installing zoffline (1.0.44368 will be installed instead of the latest).
|
|
* On your Mac machine running Zwift, copy the following files in this repo to a known location:
|
|
* ``ssl/cert-zwift-com.p12``
|
|
* ``ssl/cert-zwift-com.pem``
|
|
* Open Keychain Access, select "System" under "Keychains", select "Certificates" under "Category"
|
|
* Click "File - Import Items..." and import ``ssl/cert-zwift-com.p12``
|
|
* Right click "\*.zwift.com", select "Get Info" and under "Trust" choose "When using this certificate: Always Trust".
|
|
* If you're prompted for a password, just leave it blank. There is no password.
|
|
* Using a text editor open ``~/Library/Application Support/Zwift/data/cacert.pem``
|
|
* Append the contents of ``ssl/cert-zwift-com.pem`` to cacert.pem
|
|
* Using a text editor (with admin privileges) open ``/etc/hosts``
|
|
* Append this line: ``<zoffline ip> us-or-rly101.zwift.com secure.zwift.com cdn.zwift.com``
|
|
<br />(Where ``<zoffline ip>`` is the ip address of the machine running zoffline. If
|
|
it's running on the same machine as Zwift, use ``127.0.0.1`` as the ip.)
|
|
|
|
Why: We need to redirect Zwift to use zoffline and convince OS X and Zwift to
|
|
accept zoffline's self signed certificates for Zwift's domain names. Feel free
|
|
to generate your own certificates and do the same.
|
|
|
|
</details>
|
|
|
|
<details><summary>Android (requires a rooted device)</summary>
|
|
|
|
* Install Zwift on the device
|
|
* Open Zwift once to complete installation (i.e download all extra files).
|
|
* Append the contents of ``ssl/cert-zwift-com.pem`` to ``/data/data/com.zwift.zwiftgame/dataES/cacerts.pem`` on the device
|
|
* Note: this file will only exist after the first run of Zwift since it's downloaded after the initial install
|
|
* Simple approach to achieve this if your device doesn't have a text editor:
|
|
* ``adb push ssl/cert-zwift-com.pem /data/data/com.zwift.zwiftgame/dataES/``
|
|
* In ``adb shell``: ``cd /data/data/com.zwift.zwiftgame/dataES/``
|
|
* In ``adb shell``: ``cat cert-zwift-com.pem >> cacerts.pem``
|
|
* However you do it, ensure the permissions and ownership of the file remains the same.
|
|
* Modify the device's /etc/hosts file
|
|
* Append this line: ``<zoffline ip> us-or-rly101.zwift.com secure.zwift.com cdn.zwift.com``
|
|
<br />(Where ``<zoffline ip>`` is the ip address of the machine running zoffline.)
|
|
* If no text editor on the device, recommend:
|
|
* ``adb pull /etc/hosts``
|
|
* (modify on PC)
|
|
* ``adb push hosts /etc/hosts``
|
|
* Start Zwift and sign in using any email/password
|
|
|
|
Why: We need to redirect Zwift to use zoffline and convince Zwift to
|
|
accept zoffline's self signed certificates for Zwift's domain names. Feel free
|
|
to generate your own certificates and do the same.
|
|
|
|
</details>
|
|
|
|
#### Enabling/Disabling zoffline
|
|
|
|
To use Zwift online like normal, comment out or remove the line added to the ``hosts``
|
|
file before starting Zwift.
|
|
|
|
|
|
### Step 3 [OPTIONAL]: Obtain current Zwift profile
|
|
|
|
If you don't obtain your current Zwift profile before first starting Zwift with
|
|
zoffline enabled, you will be prompted to create a new profile (name, weight,
|
|
height, etc.)
|
|
|
|
To obtain your current profile:
|
|
* Run ``scripts/get_profile.py -u <your_zwift_username>``
|
|
* Move the resulting profile.bin (saved in whatever directory you ran get_profile.py in) into the ``storage`` directory.
|
|
* If using zoffline.exe on Windows, create the ``storage`` directory within the same folder as zoffline.exe if it does not already exist.
|
|
* If using Docker, move profile.bin into the path you passed to ``-v``
|
|
|
|
|
|
### Step 4 [OPTIONAL]: Obtain Strava API token
|
|
|
|
* Install dependencies: stravalib, six
|
|
* e.g., on Linux/Mac: ``pip install stravalib six``
|
|
* e.g., on Windows in command prompt: ``C:\Python27\Scripts\pip.exe install stravalib six``
|
|
* Get CLIENT_ID and CLIENT_SECRET from https://www.strava.com/settings/api
|
|
* Run ``scripts/strava_auth.py --client-id CLIENT_ID --client-secret CLIENT_SECRET``
|
|
* Open http://localhost:8000/ and authorize.
|
|
* Move the resulting strava_token.txt (saved in whatever directory you ran strava_auth.py in) into the ``storage`` directory.
|
|
|
|
|
|
## Dependencies
|
|
|
|
Docker
|
|
|
|
-or-
|
|
|
|
* Python 2 (https://www.python.org/downloads/)
|
|
* Flask (http://flask.pocoo.org/)
|
|
* ``pip install flask``
|
|
* protobuf_to_dict (https://github.com/benhodgson/protobuf-to-dict)
|
|
* ``pip install protobuf_to_dict``
|
|
* OPTIONAL: stravalib (https://github.com/hozn/stravalib)
|
|
* ``pip install stravalib``
|
|
|
|
|
|
## Known issues
|
|
|
|
* Segment results always show up as having just occurred.
|
|
|
|
|
|
## Note
|
|
|
|
Future Zwift updates may break zoffline until it's updated. While zoffline is
|
|
enabled Zwift updates will not be installed.
|
|
|
|
Don't expose zoffline to the internet, it was not designed with that in mind.
|
|
|
|
<details><summary>If zoffline is out of date from Zwift's official client</summary>
|
|
If zoffline is behind in support of the latest Zwift client it can be updated (if running Linux) to run using the latest Zwift version by running this script from within the zwift-offline repository: https://gist.github.com/zoffline/b874e93e24439f0f4fbd7b55f3876fd2
|
|
|
|
Note: there is no guarantee that an untested Zwift update will work with zoffline. However, historically, Zwift updates rarely break zoffline.
|
|
</details>
|
|
|
|
|
|
## Disclaimer
|
|
|
|
Zwift is a trademark of Zwift, Inc., which is not affiliated with the maker of
|
|
this project and does not endorse this project.
|
|
|
|
All product and company names are trademarks of their respective holders. Use of
|
|
them does not imply any affiliation with or endorsement by them.
|
|
|