JsBattle Docs

• Home
• Installation
• Configuration
• Getting Started
• Manual
  • Battle Anatomy
  • Tank Anatomy
  • AI Script
  • Tank State Object
  • Tank Control Object
  • Tank Settings Object
  • Tank Info Object
  • Extended Math Object
  • Scoring System
  • Constants and Formulas
  • Cooperative Mode
  • Bundled Enemies
• Algorithms
  • Geometry Basics
  • Shooting
  • Aiming
  • Movement
• Walkthroughs
  • Challenge #1
  • Challenge #2
  • Challenge #3
  • Challenge #4
  • Challenge #5
  • Challenge #6
• Development Guide
  • Architecture
    • Infrastructure
    • Components
    • Engine
      • Simulation
      • Renderers
      • Artificial Intelligence
  • Howtos and Manuals
    • JsBattle Engine
      • JsBattle Engine Tutorial
      • JsBattle Engine API
    • React Component
    • JsBattle Server API
    • Spritesheets
    • Adding Bundled Tanks
    • UBD files
    • Statistics
  • Development Process
    • Building Process
    • CI/CD
    • Release Procedure
    • Project Structure
    • Monorepo
    • Dependencies Update
  • Toolset

Components

Overview

Frontend

The frontend consists of two separated apps: public-facing webpage and back-office admin.

Webpage

The Webpage is a public-facing frontend app based on ReactJS. To make integration with JsBattleEngine it is wrapped by a React component (JsBattle ReactComp). The Webpage also contains static documentation (JsBattle Docs) generated automatically from markdown files in jsbattle-docs package. The frontend communicates with backed via HTTP and WebServices.

Admin

The Admin is a back-office app based on ReactJS. It communicates with backed via HTTP and WebServices. Access to Admin require proper permissions (e.g. admin role)

Backend

Backend consists of single JsBattle Server app and optional pool of JsBattle Workers. Workers and Server can run on multiple nodes allowing horizontal scaling.

Server

JsBattle Server is base on Moleculer framework. The API and static HTML content is exposed by ExpressJS.The static content of the Webpage is hosted ad /*, and Admin is available at /admin/*. The API is available via ApiGateway Service. The service receives all API calls and route them to proper micro services. The API is split into three areas:

• /api/* - public API
• /api/user/* - features available for authenticated users
• /api/admin/* - features available for authenticated admins

The authentication is handled by PassportJs and it requires connection to third-party OAuth (e.g. Github, Google, etc…). Following URLs are used to handle the authentication:

• /auth/{provider-name} - starts auth process
• /auth/{provider-name}/callback - OAuth callback URL
• /auth/logout - close the session

Worker

The Moleculer has a built-in mechanism that allows spreading services across multiple nodes. If JsBattle runs in Worker mode, it starts a node that hosts all scaleable services and connects to other nodes. See configuration and Moleculer docs for more details.

Moleculer Microservices

Following diagram shows structure of all micro services and dependencies between them.