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

Small edits to readme.

Browse Source
This commit is contained in:
Daan Vanden Bosch 2020-01-05 12:59:04 +01:00
parent e98ef9c08e
commit 66728f7096
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -56,21 +56,22 @@ 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](
src/core/data_formats). [src/core/data_formats/asm](src/core/data_formats/asm) contains a src/core/data_formats). A model of the PSO scripting byte code and data flow analysis for it can be
model of the PSO scripting byte code and data flow analysis for it. The found in [src/core/data_formats/asm](src/core/data_formats/asm). The [src/quest_editor/scripting](
[src/quest_editor/scripting](src/quest_editor/scripting) directory contains an assembler, src/quest_editor/scripting) directory contains an assembler, disassembler and (partly implemented)
disassembler and (partly implemented) virtual machine. virtual machine.
### Unit Tests ### Unit Tests
Run the unit tests with `yarn test` or `yarn test --watch` if you want the relevant tests to be Run the unit tests with `yarn test` or `yarn test --watch` if you want the relevant tests to be
re-run whenever a file is changed. The testing framework used is Jest. re-run whenever a file is changed. The testing framework used is Jest.
### Linting and Code Formatting ### Code Style, Linting and Formatting
ESLint and Prettier are used for linting and formatting. Class names are in `PascalCase` and all other identifiers are in `snake_case`.
Run with `yarn lint` and/or configure your editor to use the ESLint/Prettier configuration. ESLint and Prettier are used for linting and formatting. Run with `yarn lint` and/or configure your
editor to use the ESLint/Prettier configuration.
### Production Build ### Production Build