@ksp-gonogo/kerbcast 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -12,6 +12,12 @@ rolling their own transport.
12
12
  The Rust crate and this package ship the same SemVer version,
13
13
  bumped together by `./scripts/bump-version.sh`.
14
14
 
15
+ Building a React app? Use
16
+ [`@ksp-gonogo/kerbcast-react`](https://www.npmjs.com/package/@ksp-gonogo/kerbcast-react),
17
+ which wraps this client in a ready-made `CameraFeed` component plus
18
+ hooks. This package is its core dependency; reach for it directly when
19
+ you want the raw client, a non-React consumer, or your own transport.
20
+
15
21
  ## Install
16
22
 
17
23
  Hosted on public npm. No registry route or auth needed:
@@ -34,6 +40,11 @@ await cam.setFov(35);
34
40
  await cam.setRenderSize(384, 384);
35
41
  await cam.setDegrade(0.5);
36
42
 
43
+ // Pan/tilt and zoom, when the camera's mount supports it.
44
+ await cam.setPan(10, -5); // absolute yaw/pitch in degrees
45
+ await cam.setPanRate(0.5, 0); // persistent velocity, -1..1; 0,0 stops
46
+ await cam.setZoomRate(1); // +1 zooms in, holds until superseded
47
+
37
48
  const videoEl = document.querySelector("video")!;
38
49
  videoEl.srcObject = cam.mediaStream;
39
50
 
@@ -81,9 +92,12 @@ controls each part actually supports.
81
92
 
82
93
  - `supportsZoom`, `fov`, `fovMin`, `fovMax`. 19 of 21 stock Hullcam
83
94
  VDS parts support runtime FoV via `MuMechModuleHullCameraZoom`.
84
- - `supportsPan`, `panYawMin/Max`, `panPitchMin/Max`. Reserved for the
85
- planned mod extension that adds steerable mounts. Always `false`
86
- right now.
95
+ - `supportsPan`, `panYawMin/Max`, `panPitchMin/Max`. Whether this
96
+ camera's mount steers. Pan/tilt is fully wired end to end (`setPan`,
97
+ `setPanRate`, and the `PanZoomController` helper below); this flag
98
+ tells you whether a given part will act on it. Stock Hullcam VDS
99
+ mounts are fixed and report `false`; steerable mounts report `true`
100
+ with their travel limits. Hide the pan controls when `false`.
87
101
  - `encoderBitrateBps`, `targetBitrateBps`. Current encoder bitrate
88
102
  and the REMB-driven target. They diverge briefly when receivers'
89
103
  bandwidth estimates move.
@@ -93,6 +107,31 @@ controls each part actually supports.
93
107
  in-game CommNet signal loss. Also a real CPU optimisation when
94
108
  every consumer wants degraded video.
95
109
 
110
+ ## Pan/zoom input helper
111
+
112
+ Driving pan and zoom from a gamepad stick, nudge buttons, or an FoV
113
+ slider means rate deduplication, an analog deadzone, optimistic
114
+ accumulators for discrete nudges, a debounced slider, and echo-sync
115
+ while idle. `PanZoomController` is a headless state machine that handles
116
+ all of that with no DOM or React dependency. A `KerbcastCameraHandle`
117
+ satisfies its command sink structurally, so pass a camera straight in:
118
+
119
+ ```ts
120
+ import { PanZoomController } from "@ksp-gonogo/kerbcast";
121
+
122
+ const cam = client.camera(flightId);
123
+ const ctrl = new PanZoomController(cam);
124
+
125
+ ctrl.setPanRate(stickX, stickY); // analog stick
126
+ ctrl.nudgePan(1, 0); // discrete "pan right" button
127
+ ctrl.nudgeZoom(-1); // discrete "zoom in" button
128
+
129
+ // Keep the controller's view in sync with echoed camera state.
130
+ cam.on("change", (s) => ctrl.syncFromState(s));
131
+
132
+ ctrl.stop(); // on teardown
133
+ ```
134
+
96
135
  ## Multi-language
97
136
 
98
137
  `typeshare` also generates Kotlin, Swift, Scala, and Go. Those
@@ -175,6 +175,15 @@ export interface HelloPayload {
175
175
  sidecarVersion: string;
176
176
  encoderBackend: string;
177
177
  }
178
+ /**
179
+ * Scene-state change: whether KSP is currently in a flight scene. Sent
180
+ * after `Hello` (priming) and whenever the polled in-flight flag flips,
181
+ * so clients can show a calm out-of-flight standby instead of per-camera
182
+ * SIGNAL LOST when the whole scene unloads.
183
+ */
184
+ export interface SceneStateChangedPayload {
185
+ inFlight: boolean;
186
+ }
178
187
  export interface SetDegradePayload {
179
188
  flightId: number;
180
189
  /**
@@ -526,4 +535,12 @@ export type ServerMessage =
526
535
  | {
527
536
  type: "settings-state";
528
537
  content: SettingsStatePayload;
538
+ }
539
+ /**
540
+ * Whether KSP is in a flight scene. Primed after `Hello` and
541
+ * re-broadcast when the polled in-flight flag changes.
542
+ */
543
+ | {
544
+ type: "scene-state-changed";
545
+ content: SceneStateChangedPayload;
529
546
  };
package/dist/client.d.ts CHANGED
@@ -201,6 +201,13 @@ export interface KerbcastClientEvents {
201
201
  * reflects what the plugin has applied, not just what was requested.
202
202
  */
203
203
  "settings-change": SettingsStatePayload;
204
+ /**
205
+ * Fired when a `scene-state-changed` message arrives. `true` in a
206
+ * flight scene, `false` otherwise, `undefined` before the first
207
+ * signal. Consumers use this to show a calm out-of-flight standby
208
+ * instead of per-camera SIGNAL LOST.
209
+ */
210
+ "scene-change": boolean | undefined;
204
211
  }
205
212
  /**
206
213
  * Pluggable WebRTC transport. Production code uses the default
@@ -319,6 +326,8 @@ export declare class KerbcastClient extends TypedEmitter<KerbcastClientEvents> {
319
326
  private _captureUt;
320
327
  private _captureEpoch;
321
328
  private _warpRate;
329
+ /** Whether KSP is in a flight scene. `undefined` until the first signal. */
330
+ private _inFlight;
322
331
  constructor(cfg: KerbcastClientConfig, transport?: KerbcastTransport);
323
332
  get state(): KerbcastConnectionState;
324
333
  get cameras(): ReadonlyArray<CameraState>;
@@ -343,6 +352,12 @@ export declare class KerbcastClient extends TypedEmitter<KerbcastClientEvents> {
343
352
  epoch: number;
344
353
  warpRate: number;
345
354
  };
355
+ /**
356
+ * Whether KSP is currently in a flight scene, from the sidecar's
357
+ * `scene-state-changed`. `undefined` until the first signal (so a
358
+ * consumer never flashes the out-of-flight standby on connect).
359
+ */
360
+ get inFlight(): boolean | undefined;
346
361
  /**
347
362
  * Send a `set-throttle-main-screen` command to the sidecar, which writes
348
363
  * `global.control.json` for the plugin to apply. The plugin persists the
package/dist/client.js CHANGED
@@ -233,16 +233,20 @@ class CameraHandle extends TypedEmitter {
233
233
  this._sourceless = raw === null;
234
234
  const noiseEnabled = this.client._resolveNoise(this._noiseOverride);
235
235
  if (noiseEnabled) {
236
+ // Sourceless feeds show static in flight, but go blank (black, no
237
+ // noise) out of flight so a whole-scene unload is calm.
238
+ const showStatic = raw ? this._showStatic : this._sourcelessShowStatic();
236
239
  // Reuse an existing pipeline; otherwise try to create one.
237
240
  if (!this._noisePipeline) {
238
241
  const initial = raw ? this._liveIntensity() : SOURCELESS_INTENSITY;
239
242
  this._noisePipeline = tryCreateNoisePipeline(raw, initial, {
240
- showStatic: this._showStatic,
243
+ showStatic,
241
244
  onStallChange: (stalled) => this._setStalled(stalled),
242
245
  });
243
246
  }
244
247
  else {
245
248
  this._noisePipeline.setSource(raw);
249
+ this._noisePipeline.setShowStatic(showStatic);
246
250
  }
247
251
  const pipeline = this._noisePipeline;
248
252
  if (pipeline) {
@@ -261,6 +265,23 @@ class CameraHandle extends TypedEmitter {
261
265
  // expose the raw stream directly, or null when there's no source.
262
266
  this._setOutput(raw);
263
267
  }
268
+ /**
269
+ * Whether a sourceless (destroyed/absent) feed should render static. True
270
+ * in flight (or before the scene signal), false out of flight so the feed
271
+ * goes blank rather than a wall of red static when the whole scene unloads.
272
+ */
273
+ _sourcelessShowStatic() {
274
+ return this._showStatic && this.client.inFlight !== false;
275
+ }
276
+ /**
277
+ * Internal — called by the client when the scene flag flips. Re-drives an
278
+ * existing sourceless pipeline so it switches between static and blank.
279
+ */
280
+ _refreshSceneState() {
281
+ if (this._sourceless) {
282
+ this._noisePipeline?.setShowStatic(this._sourcelessShowStatic());
283
+ }
284
+ }
264
285
  _setOutput(stream) {
265
286
  this._mediaStream = stream;
266
287
  this.emit("stream", stream);
@@ -409,6 +430,8 @@ export class KerbcastClient extends TypedEmitter {
409
430
  this._captureUt = null;
410
431
  this._captureEpoch = 0;
411
432
  this._warpRate = 1;
433
+ /** Whether KSP is in a flight scene. `undefined` until the first signal. */
434
+ this._inFlight = undefined;
412
435
  this.cfg = cfg;
413
436
  this.transport =
414
437
  transport ??
@@ -451,6 +474,14 @@ export class KerbcastClient extends TypedEmitter {
451
474
  warpRate: this._warpRate,
452
475
  };
453
476
  }
477
+ /**
478
+ * Whether KSP is currently in a flight scene, from the sidecar's
479
+ * `scene-state-changed`. `undefined` until the first signal (so a
480
+ * consumer never flashes the out-of-flight standby on connect).
481
+ */
482
+ get inFlight() {
483
+ return this._inFlight;
484
+ }
454
485
  /**
455
486
  * Send a `set-throttle-main-screen` command to the sidecar, which writes
456
487
  * `global.control.json` for the plugin to apply. The plugin persists the
@@ -740,6 +771,16 @@ export class KerbcastClient extends TypedEmitter {
740
771
  this._warpRate = msg.content.timeWarpRate ?? 1;
741
772
  this.emit("settings-change", msg.content);
742
773
  break;
774
+ case "scene-state-changed":
775
+ this._inFlight = msg.content.inFlight;
776
+ /* Re-drive every handle: out of flight, sourceless feeds go blank
777
+ instead of showing static. Scene state carries no per-camera
778
+ state, so nudge each handle to re-evaluate its presentation. */
779
+ for (const handle of this.handles.values()) {
780
+ handle._refreshSceneState();
781
+ }
782
+ this.emit("scene-change", this._inFlight);
783
+ break;
743
784
  }
744
785
  }
745
786
  /**
@@ -120,6 +120,8 @@ export declare class MockSidecar {
120
120
  get throttleMainScreen(): boolean;
121
121
  /** Push a `settings-state` event to the client (simulates a plugin-status-change broadcast). */
122
122
  fireSettingsState(payload: SettingsStatePayload): void;
123
+ /** Push a `scene-state-changed` event to the client (flight scene or not). */
124
+ fireSceneState(inFlight: boolean): void;
123
125
  /** Configure the slot-pool mids before connecting (dynamic mode). */
124
126
  withSlots(mids: string[]): this;
125
127
  /**
@@ -211,6 +211,10 @@ export class MockSidecar {
211
211
  this._throttleMainScreen = payload.throttleMainScreen;
212
212
  this._sendToClient({ type: "settings-state", content: payload });
213
213
  }
214
+ /** Push a `scene-state-changed` event to the client (flight scene or not). */
215
+ fireSceneState(inFlight) {
216
+ this._sendToClient({ type: "scene-state-changed", content: { inFlight } });
217
+ }
214
218
  /** Configure the slot-pool mids before connecting (dynamic mode). */
215
219
  withSlots(mids) {
216
220
  this._slotMids = [...mids];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ksp-gonogo/kerbcast",
3
- "version": "1.4.0",
3
+ "version": "1.5.0",
4
4
  "description": "TypeScript client for the kerbcast KSP camera-streaming sidecar. KerbcastClient wraps the WebRTC peer + control channel; wire-format types are typeshare-generated from the sidecar's Rust protocol module.",
5
5
  "license": "CC-BY-NC-SA-4.0",
6
6
  "author": "Jon Pepler",
@@ -40,6 +40,13 @@
40
40
  "README.md",
41
41
  "CHANGELOG.md"
42
42
  ],
43
+ "scripts": {
44
+ "build": "tsc",
45
+ "test": "vitest run",
46
+ "typecheck": "tsc --noEmit",
47
+ "regen": "typeshare ../../sidecar/src --lang=typescript --output-file=src/__generated__/types.ts",
48
+ "prepublishOnly": "pnpm run build"
49
+ },
43
50
  "publishConfig": {
44
51
  "access": "public"
45
52
  },
@@ -47,11 +54,5 @@
47
54
  "jsdom": "^29.0.2",
48
55
  "typescript": "^5.4.0",
49
56
  "vitest": "^4.1.4"
50
- },
51
- "scripts": {
52
- "build": "tsc",
53
- "test": "vitest run",
54
- "typecheck": "tsc --noEmit",
55
- "regen": "typeshare ../../sidecar/src --lang=typescript --output-file=src/__generated__/types.ts"
56
57
  }
57
- }
58
+ }
@@ -190,6 +190,16 @@ export interface HelloPayload {
190
190
  encoderBackend: string;
191
191
  }
192
192
 
193
+ /**
194
+ * Scene-state change: whether KSP is currently in a flight scene. Sent
195
+ * after `Hello` (priming) and whenever the polled in-flight flag flips,
196
+ * so clients can show a calm out-of-flight standby instead of per-camera
197
+ * SIGNAL LOST when the whole scene unloads.
198
+ */
199
+ export interface SceneStateChangedPayload {
200
+ inFlight: boolean;
201
+ }
202
+
193
203
  export interface SetDegradePayload {
194
204
  flightId: number;
195
205
  /**
@@ -484,5 +494,10 @@ export type ServerMessage =
484
494
  * so a freshly-connected client shows correct state immediately, and
485
495
  * re-broadcast whenever the polled plugin status shows a change.
486
496
  */
487
- | { type: "settings-state", content: SettingsStatePayload };
497
+ | { type: "settings-state", content: SettingsStatePayload }
498
+ /**
499
+ * Whether KSP is in a flight scene. Primed after `Hello` and
500
+ * re-broadcast when the polled in-flight flag changes.
501
+ */
502
+ | { type: "scene-state-changed", content: SceneStateChangedPayload };
488
503
 
@@ -1522,6 +1522,27 @@ describe("KerbcastClient.inboundVideoStats", () => {
1522
1522
  expect(client.throttleMainScreen).toBe(true);
1523
1523
  });
1524
1524
 
1525
+ it("tracks inFlight from scene-state-changed and emits scene-change", async () => {
1526
+ const sidecar = new MockSidecar();
1527
+ const client = new KerbcastClient(
1528
+ { host: "h", port: 1 },
1529
+ sidecar.createTransport(),
1530
+ );
1531
+ vi.spyOn(globalThis, "fetch").mockImplementation(() =>
1532
+ Promise.resolve(MockSidecar.makeOfferResponse([])),
1533
+ );
1534
+ const seen: (boolean | undefined)[] = [];
1535
+ client.on("scene-change", (v) => seen.push(v));
1536
+ await client.connect();
1537
+ sidecar.open();
1538
+ expect(client.inFlight).toBeUndefined();
1539
+ sidecar.fireSceneState(false);
1540
+ expect(client.inFlight).toBe(false);
1541
+ sidecar.fireSceneState(true);
1542
+ expect(client.inFlight).toBe(true);
1543
+ expect(seen).toEqual([false, true]);
1544
+ });
1545
+
1525
1546
  it("setThrottleMainScreen sends the correct command", async () => {
1526
1547
  const sidecar = new MockSidecar();
1527
1548
  const client = new KerbcastClient(
package/src/client.ts CHANGED
@@ -230,6 +230,13 @@ export interface KerbcastClientEvents {
230
230
  * reflects what the plugin has applied, not just what was requested.
231
231
  */
232
232
  "settings-change": SettingsStatePayload;
233
+ /**
234
+ * Fired when a `scene-state-changed` message arrives. `true` in a
235
+ * flight scene, `false` otherwise, `undefined` before the first
236
+ * signal. Consumers use this to show a calm out-of-flight standby
237
+ * instead of per-camera SIGNAL LOST.
238
+ */
239
+ "scene-change": boolean | undefined;
233
240
  }
234
241
 
235
242
  // ---------------------------------------------------------------------------
@@ -557,15 +564,19 @@ class CameraHandle
557
564
  const noiseEnabled = this.client._resolveNoise(this._noiseOverride);
558
565
 
559
566
  if (noiseEnabled) {
567
+ // Sourceless feeds show static in flight, but go blank (black, no
568
+ // noise) out of flight so a whole-scene unload is calm.
569
+ const showStatic = raw ? this._showStatic : this._sourcelessShowStatic();
560
570
  // Reuse an existing pipeline; otherwise try to create one.
561
571
  if (!this._noisePipeline) {
562
572
  const initial = raw ? this._liveIntensity() : SOURCELESS_INTENSITY;
563
573
  this._noisePipeline = tryCreateNoisePipeline(raw, initial, {
564
- showStatic: this._showStatic,
574
+ showStatic,
565
575
  onStallChange: (stalled) => this._setStalled(stalled),
566
576
  });
567
577
  } else {
568
578
  this._noisePipeline.setSource(raw);
579
+ this._noisePipeline.setShowStatic(showStatic);
569
580
  }
570
581
 
571
582
  const pipeline = this._noisePipeline;
@@ -586,6 +597,25 @@ class CameraHandle
586
597
  this._setOutput(raw);
587
598
  }
588
599
 
600
+ /**
601
+ * Whether a sourceless (destroyed/absent) feed should render static. True
602
+ * in flight (or before the scene signal), false out of flight so the feed
603
+ * goes blank rather than a wall of red static when the whole scene unloads.
604
+ */
605
+ private _sourcelessShowStatic(): boolean {
606
+ return this._showStatic && this.client.inFlight !== false;
607
+ }
608
+
609
+ /**
610
+ * Internal — called by the client when the scene flag flips. Re-drives an
611
+ * existing sourceless pipeline so it switches between static and blank.
612
+ */
613
+ _refreshSceneState(): void {
614
+ if (this._sourceless) {
615
+ this._noisePipeline?.setShowStatic(this._sourcelessShowStatic());
616
+ }
617
+ }
618
+
589
619
  private _setOutput(stream: MediaStream | null): void {
590
620
  this._mediaStream = stream;
591
621
  this.emit("stream", stream);
@@ -747,6 +777,8 @@ export class KerbcastClient extends TypedEmitter<KerbcastClientEvents> {
747
777
  private _captureUt: number | null = null;
748
778
  private _captureEpoch = 0;
749
779
  private _warpRate = 1;
780
+ /** Whether KSP is in a flight scene. `undefined` until the first signal. */
781
+ private _inFlight: boolean | undefined = undefined;
750
782
 
751
783
  constructor(cfg: KerbcastClientConfig, transport?: KerbcastTransport) {
752
784
  super();
@@ -799,6 +831,15 @@ export class KerbcastClient extends TypedEmitter<KerbcastClientEvents> {
799
831
  };
800
832
  }
801
833
 
834
+ /**
835
+ * Whether KSP is currently in a flight scene, from the sidecar's
836
+ * `scene-state-changed`. `undefined` until the first signal (so a
837
+ * consumer never flashes the out-of-flight standby on connect).
838
+ */
839
+ get inFlight(): boolean | undefined {
840
+ return this._inFlight;
841
+ }
842
+
802
843
  /**
803
844
  * Send a `set-throttle-main-screen` command to the sidecar, which writes
804
845
  * `global.control.json` for the plugin to apply. The plugin persists the
@@ -1122,6 +1163,16 @@ export class KerbcastClient extends TypedEmitter<KerbcastClientEvents> {
1122
1163
  this._warpRate = msg.content.timeWarpRate ?? 1;
1123
1164
  this.emit("settings-change", msg.content);
1124
1165
  break;
1166
+ case "scene-state-changed":
1167
+ this._inFlight = msg.content.inFlight;
1168
+ /* Re-drive every handle: out of flight, sourceless feeds go blank
1169
+ instead of showing static. Scene state carries no per-camera
1170
+ state, so nudge each handle to re-evaluate its presentation. */
1171
+ for (const handle of this.handles.values()) {
1172
+ handle._refreshSceneState();
1173
+ }
1174
+ this.emit("scene-change", this._inFlight);
1175
+ break;
1125
1176
  }
1126
1177
  }
1127
1178
 
@@ -270,6 +270,11 @@ export class MockSidecar {
270
270
  this._sendToClient({ type: "settings-state", content: payload });
271
271
  }
272
272
 
273
+ /** Push a `scene-state-changed` event to the client (flight scene or not). */
274
+ fireSceneState(inFlight: boolean): void {
275
+ this._sendToClient({ type: "scene-state-changed", content: { inFlight } });
276
+ }
277
+
273
278
  /** Configure the slot-pool mids before connecting (dynamic mode). */
274
279
  withSlots(mids: string[]): this {
275
280
  this._slotMids = [...mids];
package/LICENSE DELETED
@@ -1,369 +0,0 @@
1
- kerbcast
2
- Copyright (c) 2026 Jon Pepler
3
-
4
- This work is licensed under the Creative Commons
5
- Attribution-NonCommercial-ShareAlike 4.0 International License.
6
- Full legal text follows.
7
-
8
-
9
- Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
10
- Public License
11
-
12
- By exercising the Licensed Rights (defined below), You accept and agree
13
- to be bound by the terms and conditions of this Creative Commons
14
- Attribution-NonCommercial-ShareAlike 4.0 International Public License
15
- ("Public License"). To the extent this Public License may be
16
- interpreted as a contract, You are granted the Licensed Rights in
17
- consideration of Your acceptance of these terms and conditions, and the
18
- Licensor grants You such rights in consideration of benefits the
19
- Licensor receives from making the Licensed Material available under
20
- these terms and conditions.
21
-
22
-
23
- Section 1 -- Definitions.
24
-
25
- a. Adapted Material means material subject to Copyright and Similar
26
- Rights that is derived from or based upon the Licensed Material
27
- and in which the Licensed Material is translated, altered,
28
- arranged, transformed, or otherwise modified in a manner requiring
29
- permission under the Copyright and Similar Rights held by the
30
- Licensor. For purposes of this Public License, where the Licensed
31
- Material is a musical work, performance, or sound recording,
32
- Adapted Material is always produced where the Licensed Material is
33
- synched in timed relation with a moving image.
34
-
35
- b. Adapter's License means the license You apply to Your Copyright
36
- and Similar Rights in Your contributions to Adapted Material in
37
- accordance with the terms and conditions of this Public License.
38
-
39
- c. BY-NC-SA Compatible License means a license listed at
40
- creativecommons.org/compatiblelicenses, approved by Creative
41
- Commons as essentially the equivalent of this Public License.
42
-
43
- d. Copyright and Similar Rights means copyright and/or similar rights
44
- closely related to copyright including, without limitation,
45
- performance, broadcast, sound recording, and Sui Generis Database
46
- Rights, without regard to how the rights are labeled or
47
- categorized. For purposes of this Public License, the rights
48
- specified in Section 2(b)(1)-(2) are not Copyright and Similar
49
- Rights.
50
-
51
- e. Effective Technological Measures means those measures that, in the
52
- absence of proper authority, may not be circumvented under laws
53
- fulfilling obligations under Article 11 of the WIPO Copyright
54
- Treaty adopted on December 20, 1996, and/or similar international
55
- agreements.
56
-
57
- f. Exceptions and Limitations means fair use, fair dealing, and/or
58
- any other exception or limitation to Copyright and Similar Rights
59
- that applies to Your use of the Licensed Material.
60
-
61
- g. License Elements means the license attributes listed in the name
62
- of a Creative Commons Public License. The License Elements of this
63
- Public License are Attribution, NonCommercial, and ShareAlike.
64
-
65
- h. Licensed Material means the artistic or literary work, database,
66
- or other material to which the Licensor applied this Public
67
- License.
68
-
69
- i. Licensed Rights means the rights granted to You subject to the
70
- terms and conditions of this Public License, which are limited to
71
- all Copyright and Similar Rights that apply to Your use of the
72
- Licensed Material and that the Licensor has authority to license.
73
-
74
- j. Licensor means the individual(s) or entity(ies) granting rights
75
- under this Public License.
76
-
77
- k. NonCommercial means not primarily intended for or directed towards
78
- commercial advantage or monetary compensation. For purposes of
79
- this Public License, the exchange of the Licensed Material for
80
- other material subject to Copyright and Similar Rights by digital
81
- file-sharing or similar means is NonCommercial provided there is
82
- no payment of monetary compensation in connection with the
83
- exchange.
84
-
85
- l. Share means to provide material to the public by any means or
86
- process that requires permission under the Licensed Rights, such
87
- as reproduction, public display, public performance, distribution,
88
- dissemination, communication, or importation, and to make material
89
- available to the public including in ways that members of the
90
- public may access the material from a place and at a time
91
- individually chosen by them.
92
-
93
- m. Sui Generis Database Rights means rights other than copyright
94
- resulting from Directive 96/9/EC of the European Parliament and of
95
- the Council of 11 March 1996 on the legal protection of databases,
96
- as amended and/or succeeded, as well as other essentially
97
- equivalent rights anywhere in the world.
98
-
99
- n. You means the individual or entity exercising the Licensed Rights
100
- under this Public License. Your has a corresponding meaning.
101
-
102
-
103
- Section 2 -- Scope.
104
-
105
- a. License grant.
106
-
107
- 1. Subject to the terms and conditions of this Public License,
108
- the Licensor hereby grants You a worldwide, royalty-free,
109
- non-sublicensable, non-exclusive, irrevocable license to
110
- exercise the Licensed Rights in the Licensed Material to:
111
-
112
- a. reproduce and Share the Licensed Material, in whole or
113
- in part, for NonCommercial purposes only; and
114
-
115
- b. produce, reproduce, and Share Adapted Material for
116
- NonCommercial purposes only.
117
-
118
- 2. Exceptions and Limitations. For the avoidance of doubt, where
119
- Exceptions and Limitations apply to Your use, this Public
120
- License does not apply, and You do not need to comply with
121
- its terms and conditions.
122
-
123
- 3. Term. The term of this Public License is specified in Section
124
- 6(a).
125
-
126
- 4. Media and formats; technical modifications allowed. The
127
- Licensor authorizes You to exercise the Licensed Rights in
128
- all media and formats whether now known or hereafter created,
129
- and to make technical modifications necessary to do so. The
130
- Licensor waives and/or agrees not to assert any right or
131
- authority to forbid You from making technical modifications
132
- necessary to exercise the Licensed Rights, including
133
- technical modifications necessary to circumvent Effective
134
- Technological Measures. For purposes of this Public License,
135
- simply making modifications authorized by this Section 2(a)
136
- (4) never produces Adapted Material.
137
-
138
- 5. Downstream recipients.
139
-
140
- a. Offer from the Licensor -- Licensed Material. Every
141
- recipient of the Licensed Material automatically
142
- receives an offer from the Licensor to exercise the
143
- Licensed Rights under the terms and conditions of this
144
- Public License.
145
-
146
- b. Additional offer from the Licensor -- Adapted Material.
147
- Every recipient of Adapted Material from You
148
- automatically receives an offer from the Licensor to
149
- exercise the Licensed Rights in the Adapted Material
150
- under the conditions of the Adapter's License You apply.
151
-
152
- c. No downstream restrictions. You may not offer or impose
153
- any additional or different terms or conditions on, or
154
- apply any Effective Technological Measures to, the
155
- Licensed Material if doing so restricts exercise of the
156
- Licensed Rights by any recipient of the Licensed
157
- Material.
158
-
159
- 6. No endorsement. Nothing in this Public License constitutes or
160
- may be construed as permission to assert or imply that You
161
- are, or that Your use of the Licensed Material is, connected
162
- with, or sponsored, endorsed, or granted official status by,
163
- the Licensor or others designated to receive attribution as
164
- provided in Section 3(a)(1)(A)(i).
165
-
166
- b. Other rights.
167
-
168
- 1. Moral rights, such as the right of integrity, are not
169
- licensed under this Public License, nor are publicity,
170
- privacy, and/or other similar personality rights; however, to
171
- the extent possible, the Licensor waives and/or agrees not to
172
- assert any such rights held by the Licensor to the limited
173
- extent necessary to allow You to exercise the Licensed
174
- Rights, but not otherwise.
175
-
176
- 2. Patent and trademark rights are not licensed under this
177
- Public License.
178
-
179
- 3. To the extent possible, the Licensor waives any right to
180
- collect royalties from You for the exercise of the Licensed
181
- Rights, whether directly or through a collecting society
182
- under any voluntary or waivable statutory or compulsory
183
- licensing scheme. In all other cases the Licensor expressly
184
- reserves any right to collect such royalties, including when
185
- the Licensed Material is used other than for NonCommercial
186
- purposes.
187
-
188
-
189
- Section 3 -- License Conditions.
190
-
191
- Your exercise of the Licensed Rights is expressly made subject to the
192
- following conditions.
193
-
194
- a. Attribution.
195
-
196
- 1. If You Share the Licensed Material (including in modified
197
- form), You must:
198
-
199
- a. retain the following if it is supplied by the Licensor
200
- with the Licensed Material:
201
-
202
- i. identification of the creator(s) of the Licensed
203
- Material and any others designated to receive
204
- attribution, in any reasonable manner requested by
205
- the Licensor (including by pseudonym if
206
- designated);
207
-
208
- ii. a copyright notice;
209
-
210
- iii. a notice that refers to this Public License;
211
-
212
- iv. a notice that refers to the disclaimer of
213
- warranties;
214
-
215
- v. a URI or hyperlink to the Licensed Material to the
216
- extent reasonably practicable;
217
-
218
- b. indicate if You modified the Licensed Material and
219
- retain an indication of any previous modifications; and
220
-
221
- c. indicate the Licensed Material is licensed under this
222
- Public License, and include the text of, or the URI or
223
- hyperlink to, this Public License.
224
-
225
- 2. You may satisfy the conditions in Section 3(a)(1) in any
226
- reasonable manner based on the medium, means, and context in
227
- which You Share the Licensed Material. For example, it may be
228
- reasonable to satisfy the conditions by providing a URI or
229
- hyperlink to a resource that includes the required
230
- information.
231
- 3. If requested by the Licensor, You must remove any of the
232
- information required by Section 3(a)(1)(A) to the extent
233
- reasonably practicable.
234
-
235
- b. ShareAlike.
236
-
237
- In addition to the conditions in Section 3(a), if You Share
238
- Adapted Material You produce, the following conditions also apply.
239
-
240
- 1. The Adapter's License You apply must be a Creative Commons
241
- license with the same License Elements, this version or
242
- later, or a BY-NC-SA Compatible License.
243
-
244
- 2. You must include the text of, or the URI or hyperlink to, the
245
- Adapter's License You apply. You may satisfy this condition
246
- in any reasonable manner based on the medium, means, and
247
- context in which You Share Adapted Material.
248
-
249
- 3. You may not offer or impose any additional or different terms
250
- or conditions on, or apply any Effective Technological
251
- Measures to, Adapted Material that restrict exercise of the
252
- rights granted under the Adapter's License You apply.
253
-
254
-
255
- Section 4 -- Sui Generis Database Rights.
256
-
257
- Where the Licensed Rights include Sui Generis Database Rights that
258
- apply to Your use of the Licensed Material:
259
-
260
- a. for the avoidance of doubt, Section 2(a)(1) grants You the right
261
- to extract, reuse, reproduce, and Share all or a substantial
262
- portion of the contents of the database for NonCommercial purposes
263
- only;
264
-
265
- b. if You include all or a substantial portion of the database
266
- contents in a database in which You have Sui Generis Database
267
- Rights, then the database in which You have Sui Generis Database
268
- Rights (but not its individual contents) is Adapted Material,
269
- including for purposes of Section 3(b); and
270
-
271
- c. You must comply with the conditions in Section 3(a) if You Share
272
- all or a substantial portion of the contents of the database.
273
-
274
- For the avoidance of doubt, this Section 4 supplements and does not
275
- replace Your obligations under this Public License where the Licensed
276
- Rights include other Copyright and Similar Rights.
277
-
278
-
279
- Section 5 -- Disclaimer of Warranties and Limitation of Liability.
280
-
281
- a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
282
- EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
283
- AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
284
- ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
285
- IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
286
- WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
287
- PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
288
- ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
289
- KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
290
- ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
291
-
292
- b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
293
- TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
294
- NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
295
- INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
296
- COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
297
- USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
298
- ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
299
- DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
300
- IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
301
-
302
- c. The disclaimer of warranties and limitation of liability provided
303
- above shall be interpreted in a manner that, to the extent
304
- possible, most closely approximates an absolute disclaimer and
305
- waiver of all liability.
306
-
307
-
308
- Section 6 -- Term and Termination.
309
-
310
- a. This Public License applies for the term of the Copyright and
311
- Similar Rights licensed here. However, if You fail to comply with
312
- this Public License, then Your rights under this Public License
313
- terminate automatically.
314
-
315
- b. Where Your right to use the Licensed Material has terminated under
316
- Section 6(a), it reinstates:
317
-
318
- 1. automatically as of the date the violation is cured, provided
319
- it is cured within 30 days of Your discovery of the
320
- violation; or
321
-
322
- 2. upon express reinstatement by the Licensor.
323
-
324
- For the avoidance of doubt, this Section 6(b) does not affect any
325
- right the Licensor may have to seek remedies for Your violations
326
- of this Public License.
327
-
328
- c. For the avoidance of doubt, the Licensor may also offer the
329
- Licensed Material under separate terms or conditions or stop
330
- distributing the Licensed Material at any time; however, doing so
331
- will not terminate this Public License.
332
-
333
- d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
334
- License.
335
-
336
-
337
- Section 7 -- Other Terms and Conditions.
338
-
339
- a. The Licensor shall not be bound by any additional or different
340
- terms or conditions communicated by You unless expressly agreed.
341
-
342
- b. Any arrangements, understandings, or agreements regarding the
343
- Licensed Material not stated herein are separate from and
344
- independent of the terms and conditions of this Public License.
345
-
346
-
347
- Section 8 -- Interpretation.
348
-
349
- a. For the avoidance of doubt, this Public License does not, and
350
- shall not be interpreted to, reduce, limit, restrict, or impose
351
- conditions on any use of the Licensed Material that could lawfully
352
- be made without permission under this Public License.
353
-
354
- b. To the extent possible, if any provision of this Public License is
355
- deemed unenforceable, it shall be automatically reformed to the
356
- minimum extent necessary to make it enforceable. If the provision
357
- cannot be reformed, it shall be severed from this Public License
358
- without affecting the enforceability of the remaining terms and
359
- conditions.
360
-
361
- c. No term or condition of this Public License will be waived and no
362
- failure to comply consented to unless expressly agreed to by the
363
- Licensor.
364
-
365
- d. Nothing in this Public License constitutes or may be interpreted
366
- as a limitation upon, or waiver of, any privileges and immunities
367
- that apply to the Licensor or You, including from the legal
368
- processes of any jurisdiction or authority.
369
-