mirror_maker/lainTSX
1
0
Fork 0
mirror of https://github.com/ad044/lainTSX.git synced 2024-10-22 23:19:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
ad044 2022-07-24 20:35:41 +04:00
parent 482039c05e
commit 28c0c33fa5
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -14,24 +14,24 @@ Building locally is currently not possible. This is because the repository lacks
## Code strutcure ## Code strutcure
- **src/** - **\_\_tests\_\_/** - Jest tests.
- **/\_\_tests\_\_/** - Jest tests. - **src/**
- **/components/** - TSX components used in the actual 3D environment (sprites, meshes, etc.). - **components/canvas/** - TSX components used in the actual 3D environment (sprites, meshes, etc.).
- **/dom-components/** - TSX components used in the website itself (index page, guide, notes, etc.). - **components/dom/** - TSX components used for the website pages.
- **/core/** - State management. Contextual (scene/state influenced) processors, mutation handler, event templates. - **core/** - State management. Contextual (scene/state influenced) processors, mutation handler, event templates.
- **/helpers/** - Helper functions used to boostrap functionalities (node finding algorithm, name selection handlers, etc.). - **hooks/** - Custom hooks for React.
- **/hooks/** - Custom hooks for React. - **json/** - Reverse-engineered JSON data the game uses for a variety of tasks (node positions, font texture atlas definitions, etc.).
- **/resources/** - Mostly reverse-engineered JSON data the game uses for a variety of tasks (node positions, font texture atlas definitions, etc.). - **pages/** - Pages for the website (index, notes, guide, options, etc.).
- **/scenes/** - TSX components containing scene definitions. - **shaders/** - Fragment/Vertex shaders.
- **/static/** - Static files (sprites, css, sfx, media, fonts). - **styles/** - CSS.
- **/types/** - Type definitions. - **types/** - Type definitions.
- **/utils/** - Utility functions. - **utils/** - Utilities/helper functions used to boostrap functionalities (node finding algorithm, name selection handlers, etc.).
- **store.ts** - Zustand store used for managing global state. - **store.ts** - Zustand store used for managing global state.
- **scripts/** - **scripts/**
- **/extract/** - WIP extraction script to automate the local building process of the game. - **extract/** - WIP extraction script to automate the local building process of the game.
## TODO ## TODO
@ -41,14 +41,14 @@ Building locally is currently not possible. This is because the repository lacks
## Screenshots ## Screenshots
<p align="center"> <p align="center">
<img src="markdown/1.png" width="49%"> <img src="screenshots/1.png" width="49%">
<img src="markdown/2.jpg" width="49%"> <img src="screenshots/2.jpg" width="49%">
<img src="markdown/3.png" width="49%"> <img src="screenshots/3.png" width="49%">
<img src="markdown/4.png" width="49%"> <img src="screenshots/4.png" width="49%">
<img src="markdown/5.png" width="49%"> <img src="screenshots/5.png" width="49%">
<img src="markdown/6.png" width="49%"> <img src="screenshots/6.png" width="49%">
<img src="markdown/7.png" width="49%"> <img src="screenshots/7.png" width="49%">
<img src="markdown/8.png" width="49%"> <img src="screenshots/8.png" width="49%">
</p> </p>
## Reporting bugs and contributing ## Reporting bugs and contributing