Sancaros/phantasmal-world
1
0
Fork 0
mirror of https://github.com/DaanVandenBosch/phantasmal-world.git synced 2025-04-04 06:28:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
A suite of tools for Phantasy Star Online.
870 Commits 6 Branches 1 Tag 210 MiB
Kotlin 99.9%
89b88a0a2d
Go to file
Daan Vanden Bosch 89b88a0a2d Put all shared build logic in precompiled gradle conventions plugins.
2021-07-24 20:13:02 +02:00
.github/workflows Cache more things in GH actions. 2021-04-26 19:47:25 +02:00
buildSrc Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
core Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
gradle/wrapper Upgraded Gradle to 7.1.1 and Kotlin to 1.5.21. 2021-07-24 12:14:43 +02:00
lib Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
observable Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
test-utils Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
web Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
webui Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
.gitignore Created gradle plugin with workaround for https://youtrack.jetbrains.com/issue/KT-42923. 2020-11-13 22:58:13 +01:00
build.gradle.kts Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00
FEATURES.md Improvements to several observables and more unit tests. 2021-06-19 10:04:06 +02:00
gradle.properties Started porting Phantasmal World to Kotlin. 2020-10-10 23:48:38 +02:00
gradlew Made gradlew executable. 2021-03-23 17:31:37 +01:00
gradlew.bat Upgraded Kotlin to 1.4.30 and Gradle to 6.8.2. Set the Kotlin JVM version to 11. Added a subproject for offline asset generation which, at the moment, can generate the list of item types. Ported unitxt and ItemPMT parsing. 2021-03-06 13:33:04 +01:00
LICENSE Added license. 2019-05-28 18:43:34 +02:00
README.md Fixed error in README. 2021-03-23 17:14:45 +01:00
settings.gradle.kts Put all shared build logic in precompiled gradle conventions plugins. 2021-07-24 20:13:02 +02:00

README.md

Phantasmal World

Phantasmal World is a suite of tools for Phantasy Star Online.

Developers

Phantasmal World is written in Kotlin and uses the Gradle build tool. Much of the code is multiplatform and reusable as a library.

Tests status Tests status

Features and Bugs

See features for a list of features, planned features and bugs.

Getting Started

  1. Install Java 11+ (e.g. AdoptOpenJDK or GraalVM)
  2. cd to the project directory
  3. Launch webpack server on http://localhost:1623/ with ./gradlew :web:run --continuous
  4. web/src/main/kotlin/world/phantasmal/web/Main.kt is the application's entry point

IntelliJ IDEA 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

Exploring the Code Base

The code base is divided up into the following gradle subprojects.

core

Core contains the basic utilities that all other subprojects directly or indirectly depend on.

lib

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.

observable

A full-fledged multiplatform implementation of the observer pattern.

test-utils

Test utilities used by the other subprojects.

web

The actual Phantasmal World web application.

webgui

Web GUI toolkit used by Phantasmal World.

Unit Tests

Run the unit tests with ./gradlew check. JS tests are run with Karma and Mocha, JVM tests with Junit 5.

Code Style and Formatting

The Kotlin coding conventions are used.

Production Build

Create an optimized production build with ./gradlew :web:browserDistribution.