File Structures
An ASCII-art folder structure diagram.
VeinIF/
βββ assets
β βββ css
β βββ images
βββ src
β βββ core <-------- core part of the framework. We advise to leave it alone.
β β βββ condition/
β β β βββ choiceCondition.ts
β β β βββ consequences.ts
β β β βββ itemCondition.ts
β β βββ inventory/
β β β βββ inventory.ts
β β βββ model/ <------ contains interfaces for type checking.
β β β βββ item.ts
β β β βββ paragraph.ts
β β β βββ player.ts
β β β βββ save.ts
β β β βββ stat.ts
β β βββ paragraphs/
β β β βββ paragraphFunctions.ts
β β β βββ showChoices.ts
β β β βββ showItems.ts
β β βββ player/
β β β βββ pronouns.ts
β β β βββ statInfos.ts
β β βββ script/
β β βββ index.ts
β β βββ saveScript.ts
β β βββ settings.ts
β βββ electron-src
β β βββ index.js <------- configurations for Electron build.
β β βββ /files that generated from running web distribution/
β βββ game
β β βββ allParagraphs.ts <<<========== Where the game content is at.
β β βββ playerInfo.ts
β βββ tools/
β β βββ formatting.ts
βββ dist/
β βββ web <------- generated after running web distribution
β βββ win-unpacked <------- generated after running windows distibution
β βββ /other files generated from building windows distribution/
βββ index.html
βββ package.json
βββ BuildGUI.exe
βββ /other dependency, package, webpack and batch files/
Last updated
Was this helpful?