Giter Club home page Giter Club logo

posis's Introduction

POSIS

Portable Operating System Interface for Screeps

Rationale

See POSIX.

Basic general workflow

  • Host OS loads a foreign bundle in its own way (usually an import somewhere)
  • Host calls install(registry: IPosisProcessRegistry) on the bundle (see IPosisBundle)
  • Bundle registers all its processes by calling registry.register(...) for each of them (see IPosisProcessRegistry). This puts processes in host's general process registry (details are specific to particular host).
  • Host starts one or more bundle's processes, possibly using optional rootImageName specified by the bundle.
  • A bundle process gets constructed with IPosisProcessContext -- a host provided handler carrying memory accessor and other goodies. See IPosisProcessContext.
  • Eventually host runs the process by executing its run() method. See IPosisProcess.
  • Process queries interfaces that the host provides and uses them to do evil or launch more child processes.

Writing compatibility layer

Host OS must provide at least IPosisKernel implementation, and ideally all other defined extensions.

This project provides typescript interfaces that serve as is in typescript projects and as documentation for poor souls using plain JS.

To use types in typescript project, install typings

$ npm install typings --saveDev

Add or modify typings.json with

{
  "name": "whatever",
  "globalDependencies": {
    "posis-api": "github:screepers/POSIS/dist/index.d.ts#master"
  }
}

Make sure typings are included in tsconfig.json

  "include": [
    "typings/**/*.d.ts"
   ]

Writing compatible process

For an example see test bundle.

Extensions

IPosisKernel

Base kernel, exposes ways to start/stop/reparent or find a process. IPosisKernel

IPosisSpawnExtension

Known posis bundles

posis's People

Contributors

alinanova21 avatar ezolenko avatar riftlurker avatar anisoptera avatar

Stargazers

Roman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.