2019-05-29 00:40:48 +08:00
|
|
|
# Phantasmal World
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:48 +08:00
|
|
|
Phantasmal World is a suite of tools for Phantasy Star Online. This project is in a very early stage of development.
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
## For Developers
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
React is used for the frontend, MobX is used for state management and THREE.js for 3D graphics.
|
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
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
1. Install Yarn ([https://yarnpkg.com/](https://yarnpkg.com/))
|
|
|
|
|
2. cd to the project directory
|
2019-07-27 07:49:19 +08:00
|
|
|
3. Launch server on [http://localhost:8080/](http://localhost:8080/) with `yarn start`
|
2019-05-29 00:40:29 +08:00
|
|
|
4. src/index.tsx is the application's entry point
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
### Tests
|
2019-05-28 19:44:17 +08:00
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
Run tests with `yarn test`.
|
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
|
|
|
|
2019-05-29 00:40:29 +08:00
|
|
|
1. Change the homepage field in package.json if you don't want to deploy to /
|
|
|
|
|
3. Build with `yarn build`
|
