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?