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

Fixed readme links.

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

16
README.md
View File

@ -8,12 +8,12 @@ See [features](./FEATURES.md) for a list of features, planned features and bugs.
### Getting Started
1. Install Node.js ([https://nodejs.org/]())
2. Install Yarn ([https://yarnpkg.com/]())
1. Install Node.js ([https://nodejs.org/](https://nodejs.org/))
2. Install Yarn ([https://yarnpkg.com/](https://yarnpkg.com/))
3. `cd` to the project directory
4. Install dependencies with `yarn`
5. Launch server on [http://localhost:1623/]() with `yarn start`
6. [src/index.ts]() is the application's entry point
5. Launch server on [http://localhost:1623/](http://localhost:1623/) with `yarn start`
6. [src/index.ts](src/index.ts) is the application's entry point
### Exploring the Code Base
@ -55,9 +55,11 @@ shared state such as the currently selected entity in the quest editor.
#### Some Interesting Parts of the Code Base
Phantasmal contains parsers for many of the client's formats in [src/core/data_formats](). The
[src/quest_editor/scripting]() directory contains an assembler, disassembler, (partly implemented)
virtual machine and data flow analysis for the PSO scripting byte code.
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
model of the PSO scripting byte code and data flow analysis for it. The
[src/quest_editor/scripting](src/quest_editor/scripting) directory contains an assembler,
disassembler and (partly implemented) virtual machine.
### Unit Tests