Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Changelog

## Unreleased v0.2.0 candidate
## v0.2.0

- Added an optional visual authoring console for mapping one video range to a captured model point, previewing privately and publishing the annotation individually.
- Clarified the generated demo's three chapters and added an explicit guarded refresh with rollback for existing synthetic installations.
- Preserved a manually chosen camera during direct pin playback and retained selection at a guided range's exclusive end.
- Corrected blank point validation, dark-mode branding, the retained muted-light palette and the generated Top edge placement.
- Refresh clean transcript drafts from the latest server text, preserve unsaved edits during tab changes, and require explicit reconciliation before saving a conflicting transcript.
- Refreshed clean transcript drafts from the latest server text, preserved unsaved edits during tab changes, and required explicit reconciliation before saving a conflicting transcript.
- Added the 3D Humanities Lab's complete-viewport authoring tutorial, poster, timed description and setup guide.
- Added Unlock Digital's hosted collection walkthrough, still poster, optional animated preview and feature guide, with explicit presentation permissions and reuse exclusions.
- Patched brace-expansion and PyJWT dependency pins with matching license notices, and expanded browser and real-API demo checks.
- Aligned the API, web package and software citation version metadata to 0.2.0, and clarified setup and security documentation for the source and earlier releases.

3D Humanities Lab contributed the generated-demo code, guarded refresh, dependency and transcript corrections, and local authoring tutorial. Unlock Digital contributed the hosted walkthrough recording/editing and assessed incorporation of the Lab-authored media notices. The hosted media retains separate presentation permissions; inclusion grants no reuse license for those assets or depicted research content.

## v0.1.1, September 29, 2026

- Corrected public static-asset permissions, added visible evidence loading progress and the muted-light theme, and improved public object ordering, mobile cards and pagination.
Expand Down
9 changes: 9 additions & 0 deletions LICENSE_STATUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,13 @@ Copyright 2026 Craig Stevens. Loci's first-party application code, documentation

The demonstration uses original generated content. Research collections, participant records and any media you add require their own permissions. The Loci license does not grant rights to content supplied by others or to third-party software bundled as dependencies.

The hosted research walkthrough contributed by Unlock Digital is a separate
media presentation. `docs/media/hosted-walkthrough.mp4`,
`docs/media/hosted-walkthrough.jpg` and
`docs/media/hosted-walkthrough-preview.gif` are excluded from the Apache 2.0
license. There is permission to show the participants in this video; inclusion
grants no reuse license for these assets or the depicted interviews, collection
media, models and research content. The underlying collection files and datasets
remain outside the repository. See [media permissions and attribution](docs/media/README.md).

Third-party components retain their own licenses and notices. See [JavaScript notices](THIRD_PARTY_NOTICES.md), [Python notices](PYTHON_THIRD_PARTY_NOTICES.md) and the dependency inventories in `docs/`.
8 changes: 8 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,11 @@ Copyright 2026 Craig Stevens
Loci's first-party application code, documentation, original interface artwork, and generated demonstration assets are licensed under the Apache License, Version 2.0. See LICENSE.

Third-party components retain their own copyright and license terms. See THIRD_PARTY_NOTICES.md and PYTHON_THIRD_PARTY_NOTICES.md.

Hosted research walkthrough recording and editing: Unlock Digital.
docs/media/hosted-walkthrough.mp4, docs/media/hosted-walkthrough.jpg and
docs/media/hosted-walkthrough-preview.gif have separate presentation permissions
and are excluded from the Apache 2.0 license. Inclusion grants no reuse license
for these assets or the depicted interviews, collection media, models and
research content. Original captions, credits and recording attribution are
retained. See LICENSE_STATUS.md and docs/media/README.md.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ The source includes a local demonstration with one authoring account; [published

[Explore the Loci research collection](https://loci.threedeezy.com/public). This personally hosted instance shows the interface with collection objects and recorded interpretations. Its collection media and contributor material have separate permissions. The generated local demonstration below is the reproducible example included with this repository.

[![Watch the hosted Loci research collection walkthrough](docs/media/hosted-walkthrough.jpg)](docs/media/hosted-walkthrough.mp4)

[Watch or download the 64.5-second hosted walkthrough with audio (MP4)](docs/media/hosted-walkthrough.mp4) · [Read the walkthrough guide](docs/media/hosted-walkthrough.md)

Hosted walkthrough recording and editing: **Unlock Digital**. Permission to
show participants in this edited video grants no reuse license for the
walkthrough, its previews or the depicted research content. See
[media permissions and attribution](docs/media/README.md),
[Apache 2.0 scope and media exceptions](LICENSE_STATUS.md) and [NOTICE](NOTICE).

## Quickstart

Requirements: Docker Engine with Compose v2 or later, or Docker Desktop; Python 3; and internet access for dependencies and images. Containers run Linux. Application ports 8000 and 8080 must be free.
Expand Down
36 changes: 36 additions & 0 deletions docs/media/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Hosted walkthrough media

**Unlock Digital** contributed the hosted walkthrough recording and editing.
The generated local-demo code improvements and authoring video are a separate
**3D Humanities Lab** contribution.

`hosted-walkthrough.mp4` is a 64.5-second, 1920×1080, 30 fps screen recording of the published Loci research collection linked in the [hosted research instance section](../../README.md#hosted-research-instance). The recording was captured on 2026-10-04 in America/Chicago. The application stays visible throughout as the viewer browses the collection, opens Field Museum Spoon, rotates the model, selects the Woman’s Face Design annotation, plays its linked video, seeks the transcript, copies a share link, and reopens the shared moment. A fixed Times New Roman banner animates the short instructions. The video uses two short excerpts of original recording audio synchronized to the browser playback clock and retains the source video's captions. The sound follows the two demonstrated playback excerpts.

Collection media and contributor material retain their own permissions and attribution requirements. Loci software and generated local-demo content retain the terms described in the repository's [license](../../LICENSE) and [license status](../../LICENSE_STATUS.md).
Comment thread
3dhlab marked this conversation as resolved.

## Permission and reuse

The maintainer confirmed on October 4, 2026 that there is permission to show
the participants in this edited walkthrough. `hosted-walkthrough.mp4`,
`hosted-walkthrough.jpg` and `hosted-walkthrough-preview.gif` are excluded from
the software's Apache 2.0 license. Inclusion grants no reuse license for the
walkthrough video or its previews, or for the depicted collection media,
participant interviews, models or research content. Software, first-party
documentation and generated local-demo material retain their Apache 2.0 terms.
Original captions, credits and recording attribution remain visible in the video.

These files contain the edited screen recording and its previews. They include
no underlying collection datasets, source interview files or source 3D models.
The walkthrough itself is publicly viewable and downloadable. Its visible images
and audio are part of that presentation; the original research files remain
outside this repository.

## Files

- `hosted-walkthrough.mp4`: complete walkthrough with audio.
- `hosted-walkthrough-preview.gif`: optional animated preview. The README uses
the still poster so readers choose when motion and audio start.
- `hosted-walkthrough.jpg`: poster image for contexts that display a still preview.
- `hosted-walkthrough.md`: concise guide to the features shown.

The README links the still poster, full video, and feature guide beside the hosted-instance link.
Binary file added docs/media/hosted-walkthrough-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/hosted-walkthrough.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/media/hosted-walkthrough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Hosted Loci walkthrough

[Watch the complete 64.5-second walkthrough](hosted-walkthrough.mp4) · [Find the hosted collection link](../../README.md#hosted-research-instance)

The example follows **Field Museum Spoon** from the LIB 2025 VR Object Interpretations collection. It shows published research content, 3D annotations, synchronized video and transcript navigation, citation formats, and a shared timestamp. Short excerpts of the original interview audio play during the matching video passages. The original recording’s visible captions and credits are retained.

## Steps shown

- **0.0–7.0 seconds:** Explore the hosted collection.
- **7.0–14.0 seconds:** Open an object.
- **14.0–29.0 seconds:** Rotate and select.
- **29.0–36.0 seconds:** Focus view.
- **36.0–46.0 seconds:** Transcript seeking.
- **46.0–53.0 seconds:** Share evidence.
- **53.0–59.0 seconds:** Cite evidence.
- **59.0–64.5 seconds:** Restore shared context.

The application remains visible throughout. Instructions animate within the fixed top banner, with brief zooms around the annotation and citation actions.

Walkthrough recording and editing: **Unlock Digital**. The maintainer has
permission to show the participants in this edited video. Inclusion grants no
reuse license for the walkthrough, previews or depicted research content.
Underlying collection datasets, source interviews and source models remain
outside this repository.

The shared link demonstrated in the final step opens the recording at **00:21.425**. Collection media and contributor material retain their original permissions and attributions. [Media provenance](README.md) describes the recording.
Binary file added docs/media/hosted-walkthrough.mp4
Binary file not shown.
Loading