add readme
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# JSRobloxClone
|
||||
|
||||
THIS IS JUST A REPLICATION DEMO CURRENTLY! You can't make games with this at all currently.
|
||||
|
||||
A simple Roblox-like multiplayer game engine clone using JavaScript and Three.js.
|
||||
|
||||
## Features
|
||||
- DataModel-based object hierarchy
|
||||
- Multiplayer networking (WebSocket)
|
||||
- 3D rendering with Three.js
|
||||
- Workspace and replication services
|
||||
- Debug overlay for client
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Install dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
2. Start the server (ensure you have a WebSocket server running on ws://localhost:8080).
|
||||
3. Run the client:
|
||||
```bash
|
||||
node js/clientmain.js
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
- `js/core/` - Core engine classes
|
||||
- `js/instances/` - Game services and objects
|
||||
- `js/clientmain.js` - Client entry point
|
||||
Reference in New Issue
Block a user