2019-05-29 00:40:48 +08:00
|
|
|
# Phantasmal World
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2020-01-02 02:09:53 +08:00
|
|
|
[Phantasmal World](https://www.phantasmal.world/) is a suite of tools for Phantasy Star Online.
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2020-01-02 02:09:53 +08:00
|
|
|
## Developers
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Phantasmal World is written in [Kotlin](https://kotlinlang.org/) and uses
|
|
|
|
|
the [Gradle](https://gradle.org/) build tool. Much of the code
|
|
|
|
|
is [multiplatform](https://kotlinlang.org/docs/multiplatform.html) and reusable as a library.
|
2020-10-11 05:48:38 +08:00
|
|
|
|
2020-09-30 00:11:01 +08:00
|
|
|
<a href="https://github.com/DaanVandenBosch/phantasmal-world/actions?query=workflow%3ATests">
|
|
|
|
|
<img alt="Tests status" src="https://github.com/DaanVandenBosch/phantasmal-world/workflows/Tests/badge.svg">
|
|
|
|
|
</a>
|
|
|
|
|
|
2020-09-30 00:28:15 +08:00
|
|
|
<a href="https://github.com/DaanVandenBosch/phantasmal-world/actions?query=workflow%3ADeploy">
|
|
|
|
|
<img alt="Tests status" src="https://github.com/DaanVandenBosch/phantasmal-world/workflows/Deploy/badge.svg">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
### Features and Bugs
|
|
|
|
|
|
2019-09-15 00:04:28 +08:00
|
|
|
See [features](./FEATURES.md) for a list of features, planned features and bugs.
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
### Getting Started
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
1. Install Java 11+ (e.g. [AdoptOpenJDK](https://adoptopenjdk.net/)
|
|
|
|
|
or [GraalVM](https://www.graalvm.org/downloads/))
|
|
|
|
|
2. `cd` to the project directory
|
|
|
|
|
3. Launch webpack server on [http://localhost:1623/](http://localhost:1623/)
|
|
|
|
|
with `./gradlew :web:run --continuous`
|
|
|
|
|
4. [web/src/main/kotlin/world/phantasmal/web/Main.kt](web/src/main/kotlin/world/phantasmal/web/Main.kt)
|
|
|
|
|
is the application's entry point
|
|
|
|
|
|
|
|
|
|
[IntelliJ IDEA](https://www.jetbrains.com/idea/download/) is recommended for development. IntelliJ
|
|
|
|
|
setup:
|
|
|
|
|
|
|
|
|
|
1. Use Ctrl-Alt-Shift-S to open the Project Structure window and select a JDK (you can let IntelliJ
|
|
|
|
|
download a JDK if you don't have a compatible one installed)
|
|
|
|
|
2. Configure the Gradle run task:
|
|
|
|
|
1. In the Gradle window, right click web -> Tasks -> other -> run
|
|
|
|
|
2. Click "Modify Run Configuration..."
|
|
|
|
|
3. Add `--continuous` to the arguments field
|
|
|
|
|
4. Click OK
|
|
|
|
|
5. You can now start the webpack server from the main toolbar
|
2020-01-02 02:09:53 +08:00
|
|
|
|
|
|
|
|
### Exploring the Code Base
|
|
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
The code base is divided up into the following gradle subprojects.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### core
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Core contains the basic utilities that all other subprojects directly or indirectly depend on.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### lib
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Lib contains PSO file format parsers, compression/decompression code, a PSO script
|
|
|
|
|
assembler/disassembler and a work-in-progress script engine/VM. It also has a model of the PSO
|
|
|
|
|
scripting bytecode and data flow analysis for it. This subproject can be used as a library in other
|
|
|
|
|
projects.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### observable
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
A full-fledged multiplatform implementation of the observer pattern.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### test-utils
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Test utilities used by the other subprojects.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### [web](web/README.md)
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
The actual Phantasmal World web application.
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
#### webgui
|
2020-01-02 02:09:53 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Web GUI toolkit used by Phantasmal World.
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-10-08 00:26:45 +08:00
|
|
|
### Unit Tests
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Run the unit tests with `./gradlew test`. JS tests are run with Karma and Mocha, JVM tests with
|
|
|
|
|
Junit 5.
|
2019-09-15 00:04:28 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
### Code Style and Formatting
|
2019-09-15 00:04:28 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
The Kotlin [coding conventions](https://kotlinlang.org/docs/coding-conventions.html) are used.
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
### Production Build
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2021-03-24 00:01:17 +08:00
|
|
|
Create an optimized production build with `./gradlew :web:browserDistribution`.
|
