https://github.com/steditor/yard
Pixels moving on a plane.
https://github.com/steditor/yard
io-game workshop-materials
Last synced: about 2 months ago
JSON representation
Pixels moving on a plane.
- Host: GitHub
- URL: https://github.com/steditor/yard
- Owner: Steditor
- License: mit
- Created: 2020-10-21T17:57:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T00:48:39.000Z (over 2 years ago)
- Last Synced: 2025-02-01T12:45:29.472Z (3 months ago)
- Topics: io-game, workshop-materials
- Language: TypeScript
- Homepage:
- Size: 1.46 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yard
Simulate running around on a yard with many people represented as one or multiple colorful pixels.
## Setup
Create a `local.config.json` according to the template in [`local.config.json.example`](local.config.json.example).
Take note of the port you specify for the express server, you will need it both for development and deployment.
Run `npm install` in the main directory to install all packages for both server and client.
## Development
Run `npm run dev` in the main directory to start server and client in watch mode.
Access the frontend via the server URL `localhost:{{EXPRESS_PORT}}` which serves as proxy for the vue-cli dev-server.
## Deployment
### Docker
Deploy the docker image defined in [`Dockerfile`](Dockerfile).
Remember to set the environment variable `MONITOR_PASSWORD` to a secure password.
The image exposes the express server on port 2567.
### PM2
Install [PM2](https://pm2.keymetrics.io/) on your server.
Run [`.deploy/deploy.sh`](.deploy/deploy.sh) from the project's root directory.
The script will install all dependencies and build both server and client.
Afterwards it uses PM2 to run the application.
Setup your reverse proxy according to [the colyseus manual](https://docs.colyseus.io/deployment/#nginx-recommended).
Remember to put in the `EXPRESS_PORT` you specified during setup.
## Server monitoring
The server exposes the [Colyseus Monitoring Panel](https://docs.colyseus.io/tools/monitor/) under `URL:PORT/colyseus`.
Use `admin` and your local `MONITOR_PASSWORD` to login.