Airship Core

This project contains the source to BedWars & the Core package.

  • The Core package is used globally across all Airship games.
  • The BedWars game is just a game. It's not shared globally.

Prerequisites

First Steps

  1. Clone Airship into the same parent folder as this repo. That is, both "airship" and "bedwars-airship" should be siblings.
  2. In Unity Hub, click Add > Add Project From Disk and select the bedwars-airship folder.

Github Access Token

  1. An access token is required to download private code from our node repositories. Create and copy a Github Personal Access Token from Github.com. Here is the link to the create token page. Generate a "classic" token. For permissions, check "repo" and "read packages".

  1. In Unity, open menu item Airship > Configuration and paste the Github Access Token.

Setting up the TypeScript Project (Optional. Recommended for programmers only!)

Note: you must open the project in Unity before building the Typescript.

Use Git Bash on PC, or Terminal on Mac: First, cd into the TypeScript project directory.

cd Assets/Typescript~

Next, install node dependencies.

npm i

Now start the compiler in watch mode.

npm run watch

Using ParrelSync for the Server

We use a tool called ParrelSync to create a clone of the project that runs as the server. You don't make changes to the clone, only the main project. Any changes you make in the main project is auto-synced to the clone.

  1. Select ParrelSync > Clones Manager

Screenshot of ParrelSync menu options

  1. Click Create New Clone. This will generate a copy of the project that will act as our server. Once complete, set the arguments to "server"

  1. Click Open in New Editor

Compile Scripts

Before running the game, you should compile scripts. You can do this by clicking the Compile Scripts button.

Alternatively, you use terminal commands in VSCode (npm run build or npm run watch)