Island Hopper

Running the project

Install the dependencies.

npm install

The following command compiles the Rust code, and replaces the contents of src/polyglons-wasm with the artifacts. Make sure to run this command and commit the results if you modify any Rust code!

npm run build-wasm

Launch the development server.

npm start

You can navigate to localhost:3000 in your browser and explore the islands. The controls are explained in the on-screen text.

Known bugs

There are no known bugs to report.

Dependencies

Dependencies are marked unused if they are included in the source code (e.g. because they came in the with create-react-app stencil), but did not end up being effectively used by us. Removing them would be unnecessarily invasive.

npm dependencies

• three utilities to make interacting with WebGL in the browser easier
• @react-three/fiber use three in the browser
• @react-three/drei utilities to interact with @react-three/fiber
• @react-three/postprocessing unused
• @testing-library/jest-dom unused
• @testing-library/react unused
• @testing-library/user-event unused
• dat.gui used during development to make parameters adjustable from the browser
• lil-gui used during development to make parameters adjustable from the browser
• react build user interfaces using components that automatically update as dependencies change
• react-dom helper package for react
• react-scripts helper scripts for react development
• seedrandom seedable random number generator for terrain generation
• web-vitals unused

Rust dependencies

• noise used for sampling Perlin noise for terrain generation
• rustc-hash a faster hash map
• wasm-bindgen make rust code callable from the web app
• getrandom unused but included so that we can enable js feature
• nalgebra linear algebra library, comparable to GLM
• bytemuck make the creation of flat float buffers easier