TypeScript guides
Quickstart guide
6 min
welcome to the developer quickstart this guide prepares you for your first experience with the engine as a typescript developer this guide prepares you to install the ir engine in your local environment access the default projects to test and develop introduce you to the hello world tutorial docid\ ydhrvx znrogkmzf21s41 for your first hands on experience with the engine initial setup the ir engine is a web application; the following steps will help you install and run a local version note that some steps of this tutorial may differ from how you use the engine in production ℹ️ info these instructions are for ubuntu linux for windows, macos, or other linux distributions, refer to the installation docid\ ztovghihael55opvlwtry manual install ir engine on ubuntu to install and run a local version of ir engine on ubuntu, follow these steps open a terminal in the directory where you want to install the engine run the following command wget https //raw\ githubusercontent com/ir engine/ir engine/dev/scripts/ubuntu install sh && bash i /ubuntu install sh npm run reinit && npm run dev once the installation is complete, open https //localhost 3000 https //localhost 3000 in your web browser to access the engine introduction to projects projects are folders that contain all your custom code, assets, and scenes working with projects is the way you extend the engine's functionalities projects are hosted in the following directory packages/projects/projects/ access default projects ir engine includes default projects and pre installed scenes, which you can explore with studio, the engine's editor and asset management interface to access the default project open the studio by navigating to https //localhost 3000/studio https //localhost 3000/studio click on the default project card select a scene to open it to test the project's functionality click the play button to enter the scene with an avatar move around using the wasd keys or by clicking on the ground your project is now ready for editing next steps you can now start working with the engine and extend its functionality by following the ecs pattern we suggest you run through the hello world tutorial docid\ ydhrvx znrogkmzf21s41