screepers / posis Goto Github PK

View Code? Open in Web Editor NEW

12.0 6.0 8.0 96 KB

Portable Operating System Interface for Screeps

License: MIT License

screeps gitconsensus

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

Stargazers

Watchers

Forkers

riftlurker ezolenko o4kapuk anisoptera lexxicon syluximmortal deign35 hnjm

posis's Issues

0 MOVE part creeps at exact spawn locations

Currently there is no way to use 0 MOVE part creeps along with POSIS due to the lack of ability to specify an exact spawn point, or at least request access to one of the spawns. Depending on execution order, it is possible to never gain access to the desired spawn structure, since the spawn extension keeps taking it for queued creeps.

The best solution I see is to add an optional spawnId field to the spawnCreep options along with a conditionally optional directions array for specifying which direction the stationary creep should be spawned by. The implementation would be required to spawn these creeps from these exact spawns and directions when spawning this creeps. An error would be thrown if directions is supplied without a spawnId.

I can create the PR myself, but I figured I would open an issue for discussion first.

[IPosisSpawnExtension] cancelCreep

We should consider adding a function to cancel a previously ordered Creep.
This can be useful when the situation changed in an unpredictable way (e.g. a room is getting invaded or an "attack" order has been cancelled).

Proposed declaration:

/**
  * Cancel a previously ordered Creep (`spawnCreep`).
  * Returns `true` if it was cancelled successfully.
  */
cancelCreep(id: string): boolean;

[vote] [spawn extension] creep body array is sorted by decreasing process preference

First one is ideal, second one is slightly less so, etc.

Host doesn't have to honor it, but convention is that sort order represents client preferences.

Redundant object creation?

Is there any particular reason why .startProcess() has to return a container object instead of just the Id? If the launching process needs the actual process, it could call .getProcessById() using the returned Id instead of forcing the container object creation on every call of .startProcess()

https://github.com/screepers/POSIS/blob/master/src/core/IPosisKernel.d.ts#L2

[vote] all API calls take arguments in a single option parameter.

For example: (ignore the actual properties)

spawnCreep(opts: { pos: RoomPosition, bodyOptions: BodyPartConstant[][], memory?: any, priority: number });

Benefits:

Named arguments (better chance of breaking if anything changes)
Extensibility
No stupid (undefined, undefined, "stuff") to skip some optional arguments
Destructuring