https://github.com/ben-miles/subnauticapda
An unofficial second-screen companion app for the game "Subnautica."
https://github.com/ben-miles/subnauticapda
react reactjs second-screen subnautica
Last synced: 6 months ago
JSON representation
An unofficial second-screen companion app for the game "Subnautica."
- Host: GitHub
- URL: https://github.com/ben-miles/subnauticapda
- Owner: ben-miles
- License: other
- Created: 2020-06-09T14:56:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T15:06:04.000Z (8 months ago)
- Last Synced: 2024-11-03T18:34:13.465Z (8 months ago)
- Topics: react, reactjs, second-screen, subnautica
- Language: JavaScript
- Homepage: https://subnauticapda.dev
- Size: 105 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SubnauticaPDA
A second-screen companion app for the game "Subnautica." Turn your phone or tablet into an expanded version of the in-game PDA, eliminating the need to pause while looking for crafting or location info.
See it live here: [SubnauticaPDA.dev](https://subnauticapda.dev)
**UPDATE:** December 13, 2022 - [Subnautica has been updated](https://unknownworlds.com/en/news/subnautica-living-large-update-released), and now features the ability to pin crafting recipes to your HUD. The lack of this feature was the reason I originally built this app, but I've since updated it to provide additional quality-of-life improvements, like a search-as-you-type filter for crafting recipes.
[](https://vitejs.dev/)
[](https://react.dev/)
[](https://github.com/features/actions)
[](https://pages.github.com/)
## Installation
1. Clone this repository and provision a web server for the project.
2. Make sure [Node.js](https://nodejs.org) and [NPM](https://www.npmjs.com) are installed.
3. In the project's root directory, run `npm install` in the terminal.
## Development
- It's recommended to use [VSCode](https://code.visualstudio.com/).
- For a live preview of the source code, run `npm run dev`.
## Deployment
- This repo uses GitHub Actions (with [this Workflow by Vite](https://vitejs.dev/guide/static-deploy.html#github-pages)) to automatically build and deploy to GitHub Pages whenever new code is pushed to the `master` branch.
- You can also build locally by running `npm run build`, and you can preview that build with `npm run preview`.
## Special Thanks
- Most data sourced from [Subnautica Wiki on Fandom](https://subnautica.fandom.com/)
- PDA image: Modified version of ["PDA" by UnderseaDee](https://subnautica.fandom.com/wiki/PDA?file=PDA.png)
- Item images: Extracted from game files using [UABE](https://github.com/SeriousCache/UABE)
- Background video: Modified version of ["Underwater light filters down through blue water" by raymond](https://www.vecteezy.com/video/14398073-underwater-light-filters-down-through-blue-water-loop)
- Alert icon: ["Alert" by Gautam Arora](https://thenounproject.com/term/alert/574450/)
- Eye icon: ["Eye" by Poups](https://thenounproject.com/term/eye/3350406/)
- GitHub icon: ["Octicon" by GitHub](https://github.com/)
- Help icon: ["help" by Styfico](https://thenounproject.com/icon/help-6856453/)
- This project is tested with [BrowserStack](https://www.browserstack.com/)