OpenBF - client / API

This package acts as the game client source, as well as the NPM package dev-dependency for creating mods for the game.

Running openbf-client

For players

Distribution is not ready as of yet Instructions won't work until then

Installation

Step is not implemented yet

Running

Start the game by running

./openbf.sh

Browser should open automatically If it does not, try pasting localhost:8080 in your browser of choice

Developers

0. Pre-requisites:

• nodejs & npm
• deno

1. Install npm packages

npm install

2. Build using webpack/babel

./build.sh

3. Run the deno local content server

cd ./apphost

./start.sh

4. Connect your browser URL should log in console But by default its

http://localhost:8080

Building the API

This is really only useful to the project author, since there should only ever be one API.

If you want to add standard features, you have two options:

• pull request (yeah, i know)
• implement it in your own mod (see using mod imports)

You'll need to have tsc command Then run

build-types.sh

The API is published to npm with

publish.sh

using-mod-imports

Importing code that is exported from another mod can be done by:

import { things, etc } from "@modname:/some/script.js";

There is no intellisense (and usually errors) in your editor, but I plan on remedying this