magcius/noclip.website

noclip

The reverse engineering of model formats was done by many people. See the application for full credits.

Contributing

Contributions are very welcome! New games, new features, and bug fixes are all very appreciated. Even small contributions like proper map names, grouping maps and new default savestates are extremely helpful.

AI Contributions Policy

• If AI was used in any capacity for your contribution (coding, reverse engineering, authoring commit messages or PR descriptions), this must be disclosed in your pull request.
• Please only submit contributions that you have tested, reviewed, and feel you understand.
• All comments or documentation must be fully human-authored. Any AI-written or even AI-assisted comments are not allowed.
• Project maintainers reserve the right to reject contributions at any time, for any reason, including if they suspect this policy has not been correctly followed.

Development Guide

To develop for noclip.website, you'll need these requisites:

• Your code editor of choice (for example, Visual Studio Code, WebStorm),
• Node.js. Choose the latest LTS version and choose the pnpm package manager,
• rustup.

Then, use the following commands to set up your environment (only needed every so often):

• Install dependencies from npm: pnpm install,
• Set up the required rust binaries:

  rustup target add wasm32-unknown-unknown
  cd rust
  cargo install cargo-run-bin
  cargo bin --install
  

Finally, to build and run the project, use pnpm start. This will start a live-reloading environment and uses filesystem watchers to auto-build the project. To include live-reloading for Rust code as well, use pnpm start --watch.

Note that Rust will be built in debug mode by default, which can greatly affect performance. To build the project with Rust in release mode, use pnpm start:release instead.

For any questions related to development, see the Official noclip.website Discord Server's #development channel. A number of developers from the community are present there and can help answer questions if you run into any additional issues getting set up.

Controls

Third-Party Credits

All icons you see are from The Noun Project, used under Creative Commons CC-BY:

• Truncated Pyramid by Bohdan Burmich
• Images by Creative Stall
• Help by Gregor Cresnar
• Open by Landan Lloyd
• Nightshift by mikicon
• Layer by Chameleon Design
• Sand Clock by James
• Line Chart by Shastry
• Search by Alain W.
• Save by Prime Icons
• Overlap by Zach Bogart
• VR by Fauzan Adaiima
• Play Clapboard by Yoyon Pujiyono
• Undo by Numero Uno
• Redo by Numero Uno
• Zoom In by Tanvir Islam
• Zoom Out by Tanvir Islam