From f4a696e2196704f5116497f5a1a6f5f3ff4d5938 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Thu, 1 Feb 2024 12:54:19 -0800 Subject: [PATCH 1/3] doc: Simplify the installation instructions on the readme --- readme.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index d93cf29..8958f79 100644 --- a/readme.md +++ b/readme.md @@ -1,22 +1,22 @@ # Ethereal Engine Basic ## Installation - -1) Add Project to Ethereal Engine. All Ethereal Engine projects are mounted in the /packages/projects/projects sub-folder of Ethereal Engine. Using bash you could add this project using the following command: - -``` -cd etherealengine/packages/projects/projects -gh repo clone EtherealEngine/ee-tutorial-basic -cd ../../../ +1) Add the project to Ethereal Engine + _All Ethereal Engine projects are mounted in the /packages/projects/projects sub-folder._ +```bash +cd etherealengine +git clone https://github.com/EtherealEngine/ee-tutorial-basic packages/projects/projects ``` -2) Make sure you are in the root folder for Ethereal. Then run Ethereal Engine itself. There are several ways to do this. With a fresh repo from github you could do the following (from the Ethereal folder): - -``` +2) Run Ethereal Engine +```bash npm install npm run dev ``` +You can now find the tutorial in the projects section of the studio. + -3) From the web admin panel of Ethereal Engine create a 'location' for the project. See https://localhost:3000/admin . Map the project to the name 'basic'. +### _Optional: Create a 'location' route for the project_ -4) Run the project on the web by visiting it with the URL you created. See https://localhost:3000/location/basic +3) Go to the web admin panel of Ethereal Engine at https://localhost:3000/admin, and map the project to the name 'basic'. +4) Run the project on the web by opening the URL you just created: https://localhost:3000/location/basic From 1aec91f97303786f5d425231b1a936c0d9ec2738 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Thu, 1 Feb 2024 12:57:10 -0800 Subject: [PATCH 2/3] fix: Typo in clone instructions --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 8958f79..6f8ae84 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ _All Ethereal Engine projects are mounted in the /packages/projects/projects sub-folder._ ```bash cd etherealengine -git clone https://github.com/EtherealEngine/ee-tutorial-basic packages/projects/projects +git clone https://github.com/EtherealEngine/ee-tutorial-basic packages/projects/projects/ee-tutorial-basic ``` 2) Run Ethereal Engine From d5e4c1b6fab281f0a278d45834840f87ebf1383e Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Thu, 1 Feb 2024 17:37:00 -0800 Subject: [PATCH 3/3] doc: Wording fixes to the readme --- readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 6f8ae84..5484ca9 100644 --- a/readme.md +++ b/readme.md @@ -13,10 +13,10 @@ git clone https://github.com/EtherealEngine/ee-tutorial-basic packages/projects/ npm install npm run dev ``` -You can now find the tutorial in the projects section of the studio. +You can now find the tutorial in the projects section of the studio at https://localhost:3000/studio -### _Optional: Create a 'location' route for the project_ +### _Optional: Create a new 'location' for the scene_ -3) Go to the web admin panel of Ethereal Engine at https://localhost:3000/admin, and map the project to the name 'basic'. +3) Go to the web admin panel of Ethereal Engine at https://localhost:3000/admin/locations, and map the scene to the name 'basic'. 4) Run the project on the web by opening the URL you just created: https://localhost:3000/location/basic