This tools allows you to create scenes that look like they are from the game Doki Doki Literature Club.
A desktop version for window and linux is available here.
The web version is hosted here.
To get all dependencies of the project, run:
npm installThe repository only contains full quality png images. A proper web build contains png and webp both lossless and lossy compressed. To generate these files, run:
npm run assetConversionsThis takes a while initialy, but only needs to be repeated when new pngs are added. It also doesn't try to convert files that are already done, so it is faster on subsequent runs.
npm run devnpm run build:webHere, we list the dependencies that are used in the code and what they do. Everything not listed here is not required to contribute.
All code is written in typescript, an typed variant of javascript. At least basic knowledge is recommend learning for any code changes.
Used to create and manage the GUI. Everything in the components folder uses this and it is recommended learning for anyone who wants to make UI changes.
A state management tool that stores the current state of the application. All of the panels, objects, positions, etc. Basically everything that ends up in a save file. Recommended it learn for anyone who wants to change the behaviors of objects. The mayority of code using it is in the "store" folder, although the "components" frequently query and send commands to the stores.
A simple event bus to allow multiple components to communicate without needing to directly connect all components. Generally isn't needed for most tasks, but also trivial enough that learning it isn't a big deal.