Quickstart
You setup StoryScript and create a new game in just a few steps. On Windows, there are a few additional things to take care of:
- Install NodeJs when you don't have it yet. You don't need tools for native modules, so you don't need to tick the box to install Chocolatey.
- Install Visual Studio Code (VS Code) if you don't have an IDE (Integrated Development Environment) yet. You can go with the default install options.
- Open VS Code. On Windows, you'll need to do so as an administrator. You can do this by right-clicking the shortcut or executable and choose "Run as administrator".
- Open a new, empty folder for your StoryScript project.
- Open a new terminal (CONTROL + SHIFT + `).
- WINDOWS ONLY: Set the proper execution policy for scripts. You do this by running this command in the terminal:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser - Install the StoryScript NPM (Node Package Manager) package using this command:
npm i @strixit/storyscript - When you get an error on the previous step, try updating your npm version by running this command and then trying step 7 again:
npm install -g npm@latest - You can now install the StoryScript NPM (Node Package Manager) package using this command:
npm i @strixit/storyscript - Run StoryScript's setup. It will ask you for a name and create your first game:
npx storyscript setup
All set to go! To start your game, run this command in your terminal:
npx storyscript start
Your brower should open or a new tab should open in your browser, showing your new game running at http://localhost:3000/.
