Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.4 KB

README.md

File metadata and controls

74 lines (46 loc) · 2.4 KB
Raw

Hoppix

Description

Hoppix is a project that aims to provide an example TVOS application built using React Native. It includes features such as navigation, state management, and integration with web development.

Installation

To install the project, follow these steps:

  1. Install the required dependencies:

    yarn install

  2. Prebuild the app with expo before running:

    yarn prebuild

Usage

Running the TVOS Application on Apple TV or Android TV

You can run this demo application on AppleTV or AndroidTV To start the TV application, use one of the following commands:

yarn start
yarn ios
yarn android

This will initiate the TV application using React Native's Metro bundler.

Make sure you have set up the necessary emulator/device configurations on XCode or Android Studio to run the project on AppleTV or Android TV.

tvOS troubleshooting

If you get the error

CommandError: Failed to build iOS project. "xcodebuild" exited with error code 65.
To view more error logs, try building the app with Xcode directly, by opening /Users/thomasrenaud/Desktop/SpaceNavigation/react-tv-space-navigation/packages/example/ios/hoppixTv.xcworkspace.

Command line invocation:
    /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -workspace /Users/thomasrenaud/Desktop/SpaceNavigation/react-tv-space-navigation/packages/example/ios/hoppixTv.xcworkspace -configuration Debug -scheme hoppixTv -destination id=B14D0E77-99C4-486F-8096-6584A23C9476

User defaults from command line:
    IDEPackageSupportUseBuiltinSCM = YES

please delete the .xcode.env.local in your ios directory, and run the yarn ios command again.

Running the Web Application

Hoppix also supports running as a web application. To run the web version of the project, use the following command:

yarn web

This will start a development server using Webpack and serve the application in your default web browser.

Handling Remote Control

In order to use Spatial Navigation in the Web Application or TV Application, you must configure the remoteControlManager to map your keyboard or remote keys to LRUD Directions.

See Remote Control for how to manage Platform Specific remote controls.

Contributing

Contributions to Hoppix are welcome! If you find any issues or want to enhance the project, please submit a pull request or open an issue on the repository.