Skip to content

Commit

Permalink
Refine terminology and improve the solve request
Browse files Browse the repository at this point in the history
  • Loading branch information
spaaaacccee committed Nov 25, 2021
1 parent cebacfa commit 26710ed
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions protocol.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pathfinding Visualiser Protocol

_Version 1.0.1_
_Version 1.0.2_

The Pathfinding Visualiser Protocol describes the way pathfinding visualisers communicate with pathfinding solvers to deliver an interactive experience.

Expand All @@ -18,7 +18,7 @@ As per JSON-RPC specifications, requests specify a unique ID, method name, and a
id: 0,
method: "solve/pathfinding",
params: {
mapType: "grid",
format: "grid",
algorithm: "jps"
}
}
Expand Down Expand Up @@ -60,7 +60,7 @@ Retrieves basic information about the server. Used to check that the server is a

## Feature Query

### `features/mapType`
### `features/formats`

Gets a list of map types supported by the solver.

Expand Down Expand Up @@ -93,7 +93,7 @@ Gets a list of template map descriptors offered by the solver.
id: string;
name?: string;
description?: string;
type?: string;
format?: string;
}[]
```

Expand All @@ -117,11 +117,11 @@ Gets a particular template map given its ID.
name?: string;
description?: string;
content?: string;
type?: string;
format?: string;
}
```

### `features/algorithm`
### `features/algorithms`

Gets a list of algorithms supported by the solver.

Expand Down Expand Up @@ -159,9 +159,12 @@ The `mapURI` can contain a URI of one of the following formats, namely `scheme:c
{
mapURI: `${"resource" | "hash" | "trace"}${string}`;
algorithm: string;
mapType: string;
start: int;
end: int;
format: string;
instances: {
start: int;
end: int;
}
[];
}
```

Expand Down

0 comments on commit 26710ed

Please sign in to comment.