gavin/multipleWindow3dScene
1
0
Fork 0
mirror of https://github.com/bgstaal/multipleWindow3dScene.git synced 2026-03-12 17:51:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #24 from younesbram/main

Browse Source 
added better readme
This commit is contained in:
Bjørn Gunnar Staal
2023-11-27 15:54:51 +01:00
committed by GitHub
parent 2b509c06b7 2b495bbf77
commit a99ecb8a86
1 changed files with 39 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,5 +1,41 @@
## 3d scene spanning multiple windows using three.js and localStorage
# Multiple Window 3D Scene using Three.js
A simple example showing how to setup a 3d scene across windows on the same origin using three.js and localStorage. Code should be self explanatory
## Introduction
This project demonstrates a unique approach to creating and managing a 3D scene across multiple browser windows using Three.js and localStorage. It's designed for developers interested in advanced web graphics and window management techniques.
follow me on twitter at [@_nonfigurativ_](https://twitter.com/_nonfigurativ_) for more stuff like this
## Features
- 3D scene creation and rendering with Three.js.
- Synchronization of 3D scenes across multiple browser windows.
- Dynamic window management and state synchronization using localStorage.
## Installation
Clone the repository and open `index.html` in your browser to start exploring the 3D scene.
```
git clone https://github.com/bgstaal/multipleWindow3dScene
```
## Usage
The main application logic is contained within `main.js` and `WindowManager.js`. The 3D scene is rendered in `index.html`, which serves as the entry point of the application.
## Structure and Components
- `index.html`: Entry point that sets up the HTML structure and includes the Three.js library and the main script.
- `WindowManager.js`: Core class managing window creation, synchronization, and state management across multiple windows.
- `main.js`: Contains the logic for initializing the 3D scene, handling window events, and rendering the scene.
- `three.r124.min.js`: Minified version of the Three.js library used for 3D graphics rendering.
## Detailed Functionality
- `WindowManager.js` handles the lifecycle of multiple browser windows, including creation, synchronization, and removal. It uses localStorage to maintain state across windows.
- `main.js` initializes the 3D scene using Three.js, manages the window's resize events, and updates the scene based on window interactions.
## Contributing
Contributions to enhance or expand the project are welcome. Feel free to fork the repository, make changes, and submit pull requests.
## License
This project is open-sourced under the MIT License.
## Acknowledgments
- The Three.js team for their comprehensive 3D library.
- x.com/didntdrinkwater for this readme.
## Contact
For more information and updates, follow [@_nonfigurativ_](https://twitter.com/_nonfigurativ_) on Twitter.