Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.55 KB

The Guide for Nine Chronicles Launcher Contributors

Translations: 한국어.

Prerequisites

  • Node.js (v16)
  • Yarn
  • .NET Core SDK (v3.1+)
    • Not required if you don't wish to build the headless

Setting things up

When cloning on Windows, you must turn on the core.symlinks as Git For Windows doesn't enable this by default. You may need to turn on the Developer Mode to do so.

git clone -c core.symlinks=true <URL>

If you prefer to do this on GitHub CLI, you can clone the repository by: gh repo clone <repository> -- -c core.symlinks=true

After cloning, you can install the required dependencies by running these commands:

git submodule update --recursive # Download 9C Headless and Unity Player build source

yarn # installs npm dependencies
yarn build-headless # builds the headless
yarn bundle-player # downloads the unity player. if you not want to test game, you can skip this step.
yarn codegen # generates the GraphQL glue code

Running the Launcher

You should have the latest configuration file (config.json) in the dist directory to run the launcher. You can download it here: https://download.nine-chronicles.com/9c-launcher-config.json.

After doing so, you can run the launcher by running:

yarn dev

Packaging for distribution

In most cases, you shouldn't do this because we use CI builds for distribution. However, if you want to package the launcher for distribution, you can do so by running:

yarn run pack