Sancaros/phantasmal-world
1
0
Fork 0
mirror of https://github.com/DaanVandenBosch/phantasmal-world.git synced 2025-04-05 07:18:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added some text to the README.

Browse Source
This commit is contained in:
Daan Vanden Bosch 2020-04-30 19:05:16 +02:00
parent 38f4bdd484
commit 916a286a3b
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -19,10 +19,10 @@ See [features](./FEATURES.md) for a list of features, planned features and bugs.
The code base is divided up into a [core](src/core) module, an [application](src/application) module The code base is divided up into a [core](src/core) module, an [application](src/application) module
and a module per tool (e.g. [quest_editor](src/quest_editor)). The core module contains the base and a module per tool (e.g. [quest_editor](src/quest_editor)). The core module contains the base
code that the other modules depend on. The application module contains the [main application view]( code that the other modules depend on. The application module contains the
src/application/gui/ApplicationView.ts) that provides navigation between the different tools. The [main application view](src/application/gui/ApplicationView.ts) that provides navigation between the
application view lazily loads and initializes the necessary modules. Each other module represents different tools. The application view lazily loads and initializes the necessary modules. Each other
a tool such as the quest editor or the hunt optimizer. module represents a tool such as the quest editor or the hunt optimizer.
#### Submodules #### Submodules
@ -31,9 +31,12 @@ common submodules such as controllers, gui, model and stores and some module-spe
##### GUI ##### GUI
The gui submodule contains views which contain minimal logic. They simply display what their The gui submodule contains views with minimal logic. They simply display what their controller
controller provides and forward user input to it. Their only dependency is the DOM and a single provides and forward user input to it. Their only dependency is the DOM and a single controller.
controller. Keeping logic out of the views makes the UI easier to test. We don't really need to test the views
as they don't contain complex code, just testing the controller layer gives us confidence that the
UI works. The only automatic tests for the gui layer are
[snapshot tests](https://jestjs.io/docs/en/snapshot-testing).
##### Controllers ##### Controllers
@ -55,11 +58,11 @@ shared state such as the currently selected entity in the quest editor.
#### Some Interesting Parts of the Code Base #### Some Interesting Parts of the Code Base
Phantasmal contains parsers for many of the client's formats in [src/core/data_formats]( Phantasmal contains parsers for many of the client's formats in
src/core/data_formats). A model of the PSO scripting byte code and data flow analysis for it can be [src/core/data_formats](src/core/data_formats). A model of the PSO scripting byte code and data flow
found in [src/core/data_formats/asm](src/core/data_formats/asm). The [src/quest_editor/scripting]( analysis for it can be found in [src/core/data_formats/asm](src/core/data_formats/asm). The
src/quest_editor/scripting) directory contains an assembler, disassembler and (partly implemented) [src/quest_editor/scripting](src/quest_editor/scripting) directory contains an assembler,
virtual machine. disassembler and (partly implemented) virtual machine.
### Unit Tests ### Unit Tests