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?