-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
git: Merge branch 'main' into branch 'CleanUp-host2'
- Loading branch information
Showing
106 changed files
with
1,870 additions
and
1,876 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| # Hosting Manual | ||
| Learn how to host your own Ethereal Engine worlds. | ||
|
|
||
| _This page will contain an introduction to the Hosting Manual._ | ||
| <!-- TODO: This page will contain an introduction to the Hosting Manual. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,46 @@ | ||
| # Installing on Mac OS X | ||
|
|
||
| 1. Go to the root and run | ||
|
|
||
| ``` | ||
| 1. Go to the root folder where Ethereal Engine is stored and run | ||
| ```bash | ||
| npm install | ||
| npm run dev-docker | ||
| npm run dev-reinit | ||
| ``` | ||
| Or if you are on a M1 based Mac: | ||
| ```bash | ||
| # Recommended | ||
| 1. Duplicate the Terminal app, and configure it to run in Rosetta | ||
| 2. Run the above commands in Rosetta Terminal | ||
|
|
||
| Or if you are on a M1 based Mac | ||
|
|
||
| (Recommended) | ||
| 1) Duplicate the Terminal app, and configure it to run in Rosetta | ||
| 2) Run the above in Rosetta Terminal | ||
|
|
||
| (Not recommended) | ||
| ``` | ||
| # Not recommended | ||
| yarn install | ||
| ``` | ||
| > _`node-darwin` sometimes doesn't get installed properly On Apple chips. Using yarn fixes this issue._ | ||
| This is because on Apple chips the node-darwin sometimes doesn't get installed | ||
| properly and by using yarn it fixes the issue. | ||
|
|
||
| 2. Have docker started in the background and then in the terminal type | ||
|
|
||
| ``` | ||
| 2. Start docker in the background and then run: | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
| This will open the MariaDB and SQL scripts on the docker and will start the servers | ||
|
|
||
| This will open the mariaDB and SQL scripts on the docker and will start the servers | ||
| 3. To make sure your environment is set and running properly go to: | ||
| https://localhost:3000/location/default | ||
| You should be able to walk around an empty 3D scene. | ||
|
|
||
| 3. To make sure your environment is set and running properly just go to | ||
| https://localhost:3000/location/default and you should be able to walk around an empty 3D scene | ||
|
|
||
| ``` | ||
| Note : Make sure you are on Node >= 16 and have docker running. | ||
| ``` | ||
| > _Note: Make sure you are on Node.js >= 18 and have docker running._ | ||
| ## Troubleshooting Mac | ||
|
|
||
| * If you find issues on your terminal that says that access-denied for user | ||
| `server@localhost` then you can use this command | ||
|
|
||
| ``` | ||
| - If you find issues on your terminal saying | ||
| `access-denied for user server@localhost` | ||
| then you can use this command: | ||
| ```bash | ||
| brew services stop mysql | ||
| ``` | ||
|
|
||
| * If you find issue on your terminal that says | ||
| `An unexpected error occurred: "expected workspace package` | ||
| while using yarn then you can use this command in your terminal | ||
|
|
||
| ``` | ||
| - If you find issues on your terminal saying | ||
| `An unexpected error occurred: "expected workspace package` | ||
| while using yarn then you can use this command | ||
| ```bash | ||
| yarn policies set-version 1.18.0 | ||
| ``` | ||
|
|
||
| As yarn > 1.18 sometimes doesn't work properly with lerna. | ||
| > _Note: This happens because yarn > 1.18 sometimes doesn't work properly with `lerna`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,20 @@ | ||
| # Installing on Windows 10+ | ||
| 1. Install python 3 and add python installation directory path to 'PATH' env variable. | ||
| 2. Install node js | ||
| 3. Install Visual studio community edition with build tools. | ||
| > Note: If mediasoup is not installed properly then modify Visual studio setup to add c++ and Node.js support. | ||
| 4. Add path of MSbuild.exe (which is present in visual studio folder) into 'path' env variable (for example:` C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin`) | ||
| 5. Make sure to install all windows prerequisites for mediasoup as mentioned on: [https://mediasoup.org/documentation/v3/mediasoup/installation/#windows](https://mediasoup.org/documentation/v3/mediasoup/installation/#windows) | ||
| 6. Install all dependencies using `npm i`. | ||
| 7. If error persists then check for typos in environment variables. | ||
| 8. If you are on Windows, you can use docker-compose to start the `scripts/docker-compose.yml` file, or install mariadb and copy credentials (database name, username, password) from docker-compose or `.env.local` -- you will need to create an empty database with the matching name. | ||
| 1. Install Python 3 and add python installation directory path to `PATH` env variable. | ||
| 2. Install Node.js 18 | ||
| 3. Install Visual Studio Community Edition with build tools. | ||
| > Note: If mediasoup is not installed properly then modify Visual studio setup to add c++ and Node.js support. | ||
| 4. Add the path to `MSbuild.exe` _(which stored in Visual Studio's folder)_ into the `PATH` env variable | ||
| _eg: `C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin`_ | ||
| 5. Make sure to install all windows prerequisites for Mediasoup as mentioned on: [https://mediasoup.org/documentation/v3/mediasoup/installation/#windows](https://mediasoup.org/documentation/v3/mediasoup/installation/#windows) | ||
| 6. Install all dependencies using `npm install` from the root folder where you cloned Ethereal Engine. | ||
|
|
||
| `./start-db.sh` only needs to be run once. If the docker image has stopped, start it again with: | ||
| > Troubleshooting: | ||
| ``` | ||
| docker container start etherealengine_db | ||
| ``` | ||
| > 7. If the error persists: Check for typos in your environment variables. | ||
| 8. Check your WSL config for any incorrect networking settings. | ||
| https://docs.microsoft.com/en-us/windows/wsl/wsl-config#network | ||
| > 8. _(Optional):_ you can use `docker-compose` to start the `scripts/docker-compose.yml` file, or install MariaDB and copy the credentials _(database name, username, password)_ from docker-compose or `.env.local`. You will need to create an empty database with the matching name. | ||
| > Note: `./start-db.sh` only needs to be run once. If the docker image has stopped, start it again with: | ||
| `docker container start etherealengine_db` | ||
|
|
||
| > 9. Check your WSL config for any incorrect networking settings. | ||
| > https://docs.microsoft.com/en-us/windows/wsl/wsl-config#network |
Oops, something went wrong.