The PaperScope Website is a comprehensive platform designed for configuring and managing projects for PaperScope. It offers a range of features to enhance your experience, including:
- User Accounts: Manage user profiles and access levels.
- Visualizer: Web based Cesium 2D/3D map for visualizing your projects in realtime.
- Projection Mapping: Utilize a beamer for projection mapping capabilities.
The entire implementation is based on PHP-Framework "Laravel". For implementation details visit the Laraval documentation.
To update your javascript code you need to use Vite.
For local development use npm run watch
For production code us npm run production
- PHP >= 8.2 and Composer
- Node >= 20 and npm.NVM allows you to quickly install and use different versions of node
- Web Server (Apache or nginx) – Databse Server (MySQL)
To initially set up the project, you can use the install.sh script via the command line. This script will guide you through the configuration process by asking for several input values. Follow these steps:
- Open your terminal.
- Navigate to the project directory:
cd PAPERSCOPE_PROJECT_FOLDER/ - Run the
install.shscript:./install.sh
- The script will prompt you for various configuration inputs, such as database credentials, application environment settings, and other necessary parameters. Provide the required information as prompted.
Once the script completes, your project will be configured and ready to use.
Ensure that the subfolder public/ is accessible via the previously entered APP_URL configuration value from your local webserver.
Use the root account you entered during the install script setup with ROOT_EMAIL and ROOT_PASSWORD to login.
After login you can create and manage your projects
The Visualizer displays your PaperScope scene data (tracked with the PaperScope Manager) in real-time. Please ensure that the correct project ID is set in the PaperScope Manager.
The Visualizer uses either WebSockets on TCP port 443 for event-based updates or a polling mode that checks for new data every 3 seconds.
You can use a beamer for projection mapping to display a map overlay on your physical tracking area. To calibrate, drag the purple square onto your Aruco tracking marker. If both overlays are identical, the perspective transformation of the map should match your physical tracking area.
You can use the [C] key on your keyboard to toggle between calibration and view mode.
If you change the scaling to a different value, you must also update the scaling value in the PaperScope Manager.
