-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with deploy instructions
- Loading branch information
1 parent
ff290ea
commit d356ca5
Showing
1 changed file
with
39 additions
and
8 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,17 +1,48 @@ | ||
# Interactive CYOA Creator NG | ||
|
||
## Setup | ||
## Standalone Usage | ||
|
||
Make sure to install the dependencies: | ||
1. Download the latest version from https://github.com/ltouroumov/cyoa-editor/releases/ | ||
2. Update the `config/viewer/projects.json` file to add your project(s) | ||
3. Upload the directory | ||
|
||
```bash | ||
yarn install | ||
### `projects.json` file | ||
|
||
```json5 | ||
{ | ||
"items": [ | ||
{ | ||
// URL of the project.json file | ||
"remoteFileUrl": "https://raw.githubusercontent.com/ltouroumov/worm-cyoa-v6-fork/master/extract-v6.0.json", | ||
// Title displayed in the list | ||
"title": "Worm V6.0 (Pixel's Version)", | ||
// Internal identifier, used by the software | ||
"id": "worm-v6.0-pixel" | ||
} | ||
// ... | ||
], | ||
// Default CYOA to display when the page loads | ||
// Set to `null` to show the list | ||
"default": "worm-v6-lt" | ||
} | ||
``` | ||
|
||
## Development Server | ||
### `backgrounds.json` file | ||
|
||
Start the development server on `http://localhost:3000`: | ||
Controls the loading backgrounds. | ||
|
||
```bash | ||
yarn dev | ||
```json5 | ||
{ | ||
// Enable or Disable the loading backgrounds | ||
"enabled": true, | ||
// List of images to randomly choose from | ||
// If there is only one file, it will always be displayed | ||
"images": [ | ||
{ | ||
// Relative path or URL | ||
"url": "bgs/load-01.webp" | ||
} | ||
// ... | ||
] | ||
} | ||
``` |