Quickstart
The fastest way
If you have some development experience, you can probably get started in just five steps:
- Go to the StoryScript Github Repository and fork it or download the code.
- Open your forked repository or code with your favorite IDE (Integrated Development Environment, like Visual Studio Code).
- Open a terminal and install the required Node packages using this command:
npm install
- Create a new StoryScript game:
npm run create-game YourGameName
- Run your new game:
npm start
The slighly slower way
When the above is not within your comfort zone yet, try this slower-paced approach:
- Create a GitHub account. Also read about how to work with repositories and how to fork a repository.
- Create your own fork of the StoryScript repository.
- Install Git when you don't have it yet. For Windows, you can use Git for Windows. The defaults presented during installation should be fine.
- Install NodeJs when you don't have it yet. You don't need tools for native modules.
- Install Visual Studio Code (VS Code). You can go with the default install options.
- Open VS Code (when on Windows 11, open it with Administrator priviledges when you have them) and open the command palette (CONTROL + SHIFT + P). Select the Git: Clone command, put in the url of your fork and press Enter. Open the cloned repository when done.
In case you get any Git errors working with your repository (e.g. when you try to push changes), make sure your Git user name and e-mail are configured correctly.
- Open a new terminal (CONTROL + SHIFT + `). Install the required NPM packages using this command:
npm install
When you get an error saying scripts are blocked, try changing the execution policy on your computer. When the install command starts but you get an error during the install, try this command instead:
npm install --legacy-peer-deps
- Create a new StoryScript game using this command, in which you should replace YourGameName with the name of your new game. Use only letters and no spaces to prevent issues:
npm run create-game YourGameName
- You can now launch your new game. Run this command:
npm start
- Your brower should open or a new tab should open in your browser, showing your new game running at http://localhost:3000/.