Skip to content

A Map Viewer for Star Wars Galaxies. Allows the original Planets from Galaxies to be richly annotated with waypoints, markers and other content.

License

Notifications You must be signed in to change notification settings

Geit/swg-map-viewer

Repository files navigation

Star Wars Galaxies Map Viewer

A Map Viewer for Star Wars Galaxies. Uses Leaflet to allow the original Planets from Galaxies to be richly annotated with waypoints, markers and other content.

The Planet Selection screen is powered by ThreeJS, and react-three-fiber.

UI Elements are powered by Material UI.

Development

To bootstrap the project, you'll need a recent version of Node & Yarn v1 installed.

To install Node dependencies, simply run yarn.

You'll also need the following non-Node dependencies:

  • gdal2tiles-leaflet should be cloned within a sibling directory, and any of it's dependencies installed on your machine.
    • This is used to split the source planet maps into tiled versions
    • Will also require python3 to be available within your PATH.
  • pngquant to be installed on your machine.
    • Used to compress output tiles to reduce bandwidth requirements by up to 70%. Tile compression can be disabled with by using DISABLE_OPTIMIZATION=true yarn generate-tiles

When all dependencies are installed, you can run the following commands in the project folder:

yarn generate-tiles

Generate (or regenerate) the tileset used by the application. This command may take a long time to complete (Typically around 3~5 minutes).

As above, this process requires python3, gdal2tiles-leaflet, and pngquant.

By default, tiles will be compressed using pngquant to save bandwidth when hosting the application in a production environment. If you do not desire this behaviour, simply use DISABLE_OPTIMIZATION=true yarn generate-tiles.

yarn start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console, and any build errors will occupy a full screen error window.

yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

See the create-react-app docs about deployment for more information.

About

A Map Viewer for Star Wars Galaxies. Allows the original Planets from Galaxies to be richly annotated with waypoints, markers and other content.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages