mirror_maker/lainTSX
1
0
Fork 0
mirror of https://github.com/ad044/lainTSX.git synced 2024-10-22 15:09:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of the SEL PSX game port.
296 commits 2 branches 0 tags 57 MiB
TypeScript 89.5%
JavaScript 5.2%
GLSL 4%
CSS 1%
Kaitai Struct 0.3%
Find a file
ad044 42e22e3613 updated readme
2021-04-05 17:55:31 +04:00
markdown bugfixes, improved markdown 2021-03-23 21:07:16 +04:00
public lots of bugfixes 2021-03-10 23:21:11 +04:00
scripts added main page and guide, refactored some functions 2021-03-23 18:23:25 +04:00
src added custom keybinding support 2021-04-05 17:51:54 +04:00
.dockerignore Basic dockerfile for deployment 2021-03-31 12:02:36 +02:00
.gitignore static files, updated readme 2021-03-24 18:08:37 +04:00
Dockerfile Better dockerfile, copy build folder properly 2021-03-31 14:30:57 +02:00
LICENSE added license 2021-03-29 14:59:29 +04:00
package-lock.json added readme, renamed npm package 2021-03-23 20:38:40 +04:00
package.json added readme, renamed npm package 2021-03-23 20:38:40 +04:00
README.md updated readme 2021-04-05 17:55:31 +04:00
tsconfig.json too much, cant write a commit message for this 2020-10-28 21:38:09 +04:00

README.md

lainTSX

A browser-based implementation of the Serial Experiments Lain PSX game using react-three-fiber with the aim to provide multi-language support and make it more accessible.

History

The original PSX game was released in Japan, back in 1998. The game never got a proper english adaptation, which resulted in all non-japanese speaking players either having to play through the game while simultaneously reading through the translation, or simply not playing the game at all and only reading it.

The goal of this project is to provide a better experience for those willing to play the game, and the way to do so is by implementing a subtitle system, which has the capability to support multiple languages.

Building locally

Building locally is currently not possible. This is because the repository lacks static assets ripped from the game due to it being copyrighted content. The plan is to write an extraction script (currently located inside scripts/extract), where the user who owns the game provides the disc binaries themselves, and the script automates the static file extraction. This script is still WIP.

Code strutcure

  • src/

    • /__tests__/ - Jest tests.
    • /components/ - 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.).
    • /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.
    • /resources/ - Mostly reverse-engineered JSON data the game uses for a variety of tasks (node positions, font texture atlas definitions, etc.).
    • /scenes/ - TSX components containing scene definitions.
    • /static/ - Static files (sprites, css, sfx, media, fonts).
    • /types/ - Type definitions.
    • /utils/ - Utility functions.
    • store.ts - Zustand store used for managing global state.

  • scripts/

    • /extract/ - WIP extraction script to automate the local building process of the game.

TODO

  • Finish writing the extraction script
  • Improve/complete the translation
  • Implement an interface for changing languages
  • Add controller support

Screenshots

Reporting bugs and contributing

If you have any ideas/suggestions/found an issue or want to help us with the translation or anything else, please submit an issue or join our Discord server.

Tools used during development