diff --git a/.dockerignore b/.dockerignore index 33155af..d6dd405 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,4 +1,5 @@ * !go.mod +!LICENSE !*.go !web diff --git a/Dockerfile b/Dockerfile index 0c42fcf..0513063 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,6 +10,7 @@ FROM alpine:3.22 # git is needed at runtime to clone GitHub repositories. RUN apk add --no-cache git ca-certificates && adduser -D -H app COPY --from=build /codenavigator /usr/local/bin/codenavigator +COPY LICENSE /usr/share/licenses/codenavigator/LICENSE USER app ENV PORT=4177 EXPOSE 4177 diff --git a/README.md b/README.md index 719fade..958f1b7 100644 --- a/README.md +++ b/README.md @@ -77,3 +77,15 @@ docker run --rm -p 4177:4177 codenavigator:latest - [GitHub App setup](docs/GITHUB_APP.md): private repos and security alerts - [Deployment](docs/DEPLOYMENT.md): Docker, systemd, nginx, operating limits - [Development](docs/DEVELOPMENT.md): running, testing, benchmarking, project layout + +## License + +Copyright (C) 2026 Andy Dixon + +CodeNavigator is free software: you can redistribute it and/or modify it under the terms of the +GNU General Public License as published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. It is distributed WITHOUT ANY WARRANTY; see +[LICENSE](LICENSE) for the full text. + +The bundled fonts in `web/fonts/` (Archivo Black, Atkinson Hyperlegible, Space Mono) are licensed +under the SIL Open Font License 1.1; see [web/fonts/OFL.txt](web/fonts/OFL.txt). diff --git a/github.go b/github.go index 035864b..965c5d0 100644 --- a/github.go +++ b/github.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/github_test.go b/github_test.go index b697666..2b6d93b 100644 --- a/github_test.go +++ b/github_test.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/indexer.go b/indexer.go index e4e00eb..135e847 100644 --- a/indexer.go +++ b/indexer.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/indexer_test.go b/indexer_test.go index f76360f..4306dd9 100644 --- a/indexer_test.go +++ b/indexer_test.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/main.go b/main.go index 8fb2236..b514a4c 100644 --- a/main.go +++ b/main.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/main_test.go b/main_test.go index 54f8310..814c569 100644 --- a/main_test.go +++ b/main_test.go @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon + package main import ( diff --git a/web/api.mjs b/web/api.mjs index ca40c40..4c6dc05 100644 --- a/web/api.mjs +++ b/web/api.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon export function apiFetch(url, options = {}) { const headers = new Headers(options.headers); headers.set('ngrok-skip-browser-warning', 'true'); diff --git a/web/app.js b/web/app.js index 44b9093..c05bae2 100644 --- a/web/app.js +++ b/web/app.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { LandscapeRenderer, KIND } from './renderer.js'; import { layoutCity, squarifiedLayout, spatialIndex, pickRay, stepCamera, collide, blockAt, groundHit, flatQuad, wallSigns, folderBlades, folderLabel, facadeQuad, heading, tourStops, encodePlace, decodePlace, joystick, buildNavGrid, routesFrom, spawnWanderers, stepWanderers, alertsByPath, burns, tapeQuads, cityWalls, posterQuads, seededRandom, WALL, ROUTE_KIND, enterBuilding, assignDoors, routeThroughDoors, streetFurniture, furnitureBoxes, DOOR, MOVE, trafficLoops, spawnCars, carBoxes, stepCars } from './city.js'; import { LabelAtlas, PosterAtlas } from './labels.js'; diff --git a/web/camera.js b/web/camera.js index d04717f..6b4e944 100644 --- a/web/camera.js +++ b/web/camera.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon // Minimal column-major 4x4 matrix helpers and the cameras built on them. World axes: x right, // y "down" the 2D map, z up. Every 3D view renders and projects through one view-projection // matrix, so WebGL, the overlay and picking agree exactly. diff --git a/web/city.js b/web/city.js index cb4be2f..30a373b 100644 --- a/web/city.js +++ b/web/city.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon // Code as a city: folders become districts and blocks separated by roads, files become buildings. // Everything here is plain data and maths in metres, so it can be tested without a browser. diff --git a/web/config.js b/web/config.js index c3143b8..9d7203d 100644 --- a/web/config.js +++ b/web/config.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon window.CODENAVIGATOR_CONFIG = { // Empty means same origin: the Go server serves both the frontend and the API. backendUrl: '', diff --git a/web/fonts/OFL.txt b/web/fonts/OFL.txt new file mode 100644 index 0000000..b1aa267 --- /dev/null +++ b/web/fonts/OFL.txt @@ -0,0 +1,95 @@ +Copyright 2017 The Archivo Black Project Authors (https://github.com/Omnibus-Type/ArchivoBlack) +Copyright 2020 Braille Institute of America, Inc. +Copyright 2016 The Space Mono Project Authors (https://github.com/googlefonts/spacemono) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/web/labels.js b/web/labels.js index 6f9745d..45ac1d0 100644 --- a/web/labels.js +++ b/web/labels.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon // Text for the 3D city: labels are rasterised once into a shared atlas and drawn as textured quads, // so signs are depth-tested against buildings instead of floating over them like DOM or 2D overlays. diff --git a/web/people.js b/web/people.js index a26337c..59f53bb 100644 --- a/web/people.js +++ b/web/people.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon // Residents' identities. Everything is derived from a seed, so the same resident is always the same // person. Name data from nymshift's England/Wales name set; occupations and the rest from its taxonomy. import { seededRandom } from './city.js'; diff --git a/web/renderer.js b/web/renderer.js index 752b86e..ca61ce0 100644 --- a/web/renderer.js +++ b/web/renderer.js @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { perspective, lookAt, multiply, transform, invert, orbitPose, direction, ORBIT_FOV } from './camera.js'; import { ribbonVertices } from './city.js'; diff --git a/web/styles.css b/web/styles.css index 231dfd0..2e688f7 100644 --- a/web/styles.css +++ b/web/styles.css @@ -1,3 +1,5 @@ +/* SPDX-License-Identifier: GPL-3.0-or-later + Copyright (C) 2026 Andy Dixon */ /* CodeNavigator: a hand-cut dev zine. Flat ink, hard edges, stickers, a little chaos. */ @font-face { font-family: "Archivo Black"; font-weight: 400; font-display: swap; src: url("./fonts/archivo-black.woff2") format("woff2"); } @font-face { font-family: "Atkinson Hyperlegible"; font-weight: 400; font-display: swap; src: url("./fonts/atkinson-400.woff2") format("woff2"); } diff --git a/webtest/camera.test.mjs b/webtest/camera.test.mjs index 69c8553..08a59dd 100644 --- a/webtest/camera.test.mjs +++ b/webtest/camera.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { perspective, lookAt, multiply, transform, invert, orbitPose, ORBIT_FOV } from '../web/camera.js'; diff --git a/webtest/city.test.mjs b/webtest/city.test.mjs index ba89238..4b72696 100644 --- a/webtest/city.test.mjs +++ b/webtest/city.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { layoutCity, buildingHeight, spatialIndex, rayBox, pickRay, CITY } from '../web/city.js'; diff --git a/webtest/infrastructure.test.mjs b/webtest/infrastructure.test.mjs index e580081..b036b6f 100644 --- a/webtest/infrastructure.test.mjs +++ b/webtest/infrastructure.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { layoutCity, buildNavGrid, routesFrom, assignDoors, routeThroughDoors, ribbonVertices, streetFurniture, furnitureBoxes, walkable, DOOR, seededRandom, trafficLoops, spawnCars, carBoxes, carPose, stepCars, wallSigns } from '../web/city.js'; diff --git a/webtest/labels.test.mjs b/webtest/labels.test.mjs index 9ae75be..7099e70 100644 --- a/webtest/labels.test.mjs +++ b/webtest/labels.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { ShelfPacker } from '../web/labels.js'; diff --git a/webtest/nav.test.mjs b/webtest/nav.test.mjs index 9111f88..5d4a503 100644 --- a/webtest/nav.test.mjs +++ b/webtest/nav.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { buildNavGrid, routesFrom, walkable } from '../web/city.js'; diff --git a/webtest/people.test.mjs b/webtest/people.test.mjs index 8527921..d1b6b81 100644 --- a/webtest/people.test.mjs +++ b/webtest/people.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { personFor, residentSeed, NAMES, OCCUPATIONS, EMPLOYERS, BLOOD_TYPES, EYE_COLOURS, HAIR_COLOURS } from '../web/people.js'; diff --git a/webtest/place.test.mjs b/webtest/place.test.mjs index a899ec3..5615da8 100644 --- a/webtest/place.test.mjs +++ b/webtest/place.test.mjs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// Copyright (C) 2026 Andy Dixon import { test } from 'node:test'; import assert from 'node:assert/strict'; import { tourStops, encodePlace, decodePlace, joystick } from '../web/city.js';