https://github.com/signpostmarv/no-mans-sky-helper

WebGL & lit-element based helper for remembering where things are on a planet.
https://github.com/signpostmarv/no-mans-sky-helper

lit-element nomanssky threejs

Last synced: about 1 month ago
JSON representation

WebGL & lit-element based helper for remembering where things are on a planet.

• Host: GitHub
• URL: https://github.com/signpostmarv/no-mans-sky-helper
• Owner: SignpostMarv
• License: apache-2.0
• Created: 2020-04-14T11:50:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-05T20:32:13.000Z (about 2 years ago)
• Last Synced: 2024-05-02T01:15:09.825Z (8 months ago)
• Topics: lit-element, nomanssky, threejs
• Language: TypeScript
• Homepage:
• Size: 1.13 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# No Man's Sky Helper

WebGL & lit-element based helper for remembering where things are on a planet.

uses:

* lit-element

* three.js

* emojis for textures because reasons.

## Usage

* `npm install && gulp`

* copy `./dist/init.js` and `./dist/init.worker.js` to your desired location

* refer to [the example](https://github.com/SignpostMarv/No-Mans-Sky-helper/tree/master/src/examples/index.html)

### Marker API

| Name | Description | Types of Values |

| --------- | ----------- | --------------- |

| `lat` | latitude | numbers in the range of `-90.00` to `90.00` |

| `lng` | longitude | numbers in the range of `-180.00` to `180.00` |

| `title` | name for marker | descriptive string |

| `focusHere(distance: number)` | method for focusing a render view on a marker | `distance` is the number of units above the surface of the planet.

### Supported Markers

| Icon | Purpose | Tag Name |

| ---- | ------- | -------- |

| 📍 | General Purpose Marker | `nmsh-marker` |

| 🕴 | Drop Pods | `nmsh-drop-pod` |

| 🚨 | Distress Beacons | `nmsh-distress-beacon` |

| 🚢 | Crashed Freighters | `nmsh-crashed-freighter` |

| 🏫 | Monolith | `nmsh-monolith` |

| 🏺 | Knowledge Stones | `nmsh-knowledge-stone` |

| ⚙ | Damaged Machinery | `nmsh-damaged-machinery` |

| ⛏ | Mineral Deposits | `nmsh-mineral-deposit` |

| 🏢 | Building | `nmsh-building` |

| ℹ | Waypoint | `nmsh-waypoint` |

| 🏪 | Trade Post | `nmsh-trade-post` |

| 🏘 | Minor Settlements | `nmsh-minor-settlement` |

| 🗼 | Transmission Towers | `nmsh-transmission-tower` |

| 🏛 | Ancient Ruins | `nmsh-ancient-ruin` |

| 🔭 | Observatories | `nmsh-observatory` |

| 🚪 | Portals | `nmsh-portal` |

| 📦 | Cargo Drop | `nmsh-cargo-drop` |

| 🛩 | Damaged Starship | `nmsh-damaged-starship` |

| 🏭 | Manufacturing Facility | `nmsh-manufacturing-facility`|

| ⛺ | Shelters | `nmsh-shelter` |

| 📻 | Holographic Comms Tower | `nmsh-comms-tower` |

| 💽 | Ancient Data Structure | `nmsh-ancient-data-structure` |

## Demo

[![YouTube video demo](https://img.youtube.com/vi/dg5pIbQ6PX8/0.jpg)](https://www.youtube.com/watch?v=dg5pIbQ6PX8)

## License

Apache 2.0