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
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Documentation-only repository. No runtime secrets are required.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @osystic
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Repository change
about: Track a governed repository change
title: ""
labels: []
assignees: []
---

## Outcome

## Acceptance criteria
- [ ] Scope is explicit
- [ ] Security/privacy reviewed
- [ ] Evidence attached or referenced
- [ ] Documentation updated

## Owner

## Priority

## Dependencies / links
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Outcome
What changed and why?

Closes #<issue>

## Evidence
- [ ] Required structure/checks pass
- [ ] Claims are evidence-backed
- [ ] No secrets or unauthorized client material are included

## Risk and operations
- [ ] Security/privacy impact reviewed
- [ ] Publication/retention impact reviewed
- [ ] Documentation/runbook updated

## Handover
- [ ] Reviewer can reproduce or audit the result
- [ ] Repository manifest is current
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: public-safety

on:
pull_request:
push:
branches: [main]

jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Required repository standard
shell: bash
run: |
set -euo pipefail
for f in README.md CONTRIBUTING.md SECURITY.md OWNERSHIP.md NOTICE.md .osystic/repository.yml docs/architecture.md docs/runbook.md docs/handover.md docs/disclosure-boundary.md docs/publication-record.md; do
test -f "$f" || { echo "Missing $f"; exit 1; }
done
- name: Block confidential artifact types
shell: bash
run: |
set -euo pipefail
if find . -type f \( -name '*.uasset' -o -name '*.umap' -o -name '*.uproject' -o -name '*.cpp' -o -name '*.h' -o -name '*.usf' -o -name '*.mov' -o -name '*.mp4' -o -name '*.jsonl' -o -name '*.zip' \) -not -path './.git/*' | grep -q .; then
echo "Confidential/delivery artifact type detected"; exit 1
fi
- name: Block known private identifiers
shell: bash
run: |
set -euo pipefail
if grep -RniE --exclude-dir=.git --exclude='ci.yml' '(Inception-Technologies|Quarrybuild|XG-011|MD-STA-26|standalone-osystic|Matthew)' .; then
echo "Private/internal identifier detected"; exit 1
fi
52 changes: 52 additions & 0 deletions .osystic/repository.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
schema_version: 2
repository_class: labs-showcase
visibility: public
lifecycle: maintenance
business_owner: Shawaiz Arif
technical_owner: OSYSTIC
owner_team: engineering
data_classification: public-sanitized

project:
key: unreal-native-rendering-simulation
name: Native Unreal Engine Mechanical Simulation and Section Rendering
status: completed

portfolio:
eligible: true
status: approved-public-showcase
publisher: OSYSTIC
presentation_standard: company-engineering-case-study

website:
eligible: true
status: ready-for-review
canonical_slug: unreal-native-rendering-simulation
auto_sync: true

publication:
client_identity_public: false
confidential_content_removed: true
credentials_included: false
private_infrastructure_included: false
contract_or_payment_details_included: false
private_conversations_included: false
client_source_included: false
client_evidence_included: false
internal_task_identifiers_included: false
independent_git_history: true

source:
type: sanitized-client-delivery
source_code_included: false
confidential_source_linked: false
proprietary_assets_included: false

delivery:
default_branch: main
ci_required: true
production_environment: false

controls:
secrets_in_git_allowed: false
public_publication_allowed: true
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing

This repository is maintained under OSYSTIC GitHub Governance v2.2.

- Work through an issue and a short-lived branch.
- Use pull requests into main.
- Do not include client source, private screenshots, credentials, private conversations, payment data, or unapproved identifying information.
- Keep claims evidence-backed and confidentiality-safe.
- Security or privacy concerns block publication until resolved.
5 changes: 5 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Security Policy

Do not report secrets or client-confidential information in public issues.

For any suspected disclosure, stop publication or sharing, preserve evidence, and escalate through OSYSTIC's approved internal security process. Do not paste credentials, client data, private repository URLs, or proprietary source into a public report.
45 changes: 45 additions & 0 deletions case-study.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Engineering Case Study: Native Unreal Mechanical Simulation & Section Rendering

## P - Problem & constraints

A proprietary Unreal Engine engagement required two advanced capabilities to be implemented and validated under a strict code-driven delivery model.

The first capability focused on deterministic mechanical behavior: connected moving parts had to preserve coherent relationships through motion and present convincingly from a normal gameplay/viewer camera.

The second capability focused on section visualization: a moving section plane had to expose internal structure while preserving a visually legible engineering presentation and a validation path that could distinguish rendering success from superficial appearance.

Key constraints included exact engine-version compatibility, committed logic authored in code, deterministic parameter-driven behavior, repeatable build and regression checks, runtime validation of GPU-visible results, commercial-quality visual presentation, evidence/session provenance for review, and strict confidentiality around the client source and artifacts.

## A - Architecture & decisions

The confidential implementation used a layered approach.

**Native engine integration.** Unreal-facing systems handled runtime lifecycle, scene/component discovery, configuration, orchestration, and capture.

**Deterministic core logic.** Geometry and motion calculations were isolated so important invariants could be tested outside the editor where practical.

**GPU rendering path.** Shader work was used for section visualization and engineering presentation where the problem belonged in the render pipeline.

**Configuration-driven validation.** Runtime parameters and validation poses were externalized to make repeated checking deterministic.

**Independent verification.** Portable tests and runtime evidence checks were kept distinct, reducing the risk of proving only one side of the system.

**Evidence-first delivery.** Build results, tests, runtime captures and task reporting were treated as part of the deliverable rather than as afterthoughts.

## C - Contribution & delivery

OSYSTIC's engineering work covered native C++ feature implementation, GPU shader/rendering integration where required, deterministic simulation and geometry logic, automated regression tooling, runtime validation orchestration, visual-quality iteration, evidence capture, delivery documentation, and final branch/PR submission under the client's controlled workflow.

The two workstreams were delivered separately to keep review scope auditable.

## E - Evidence & outcomes

The private closeout record confirms that both final task branches were present on the client's remote repository at their delivered commits and that both review pull requests remained open, matching the client's required workflow.

Private validation included required Unreal Engine builds, automated regression checks, runtime/GPU verification for the rendering work, visual-quality review in motion, and captured evidence packaged with the delivery.

This public case study intentionally does not reproduce the evidence, source, task identifiers, exact tolerances, screenshots or client repository references.

## Confidentiality

This repository is a clean public narrative derived from verified delivery facts. It is not a fork, mirror, source export or substitute for the confidential project.
16 changes: 16 additions & 0 deletions docs/adr/0001-independent-sanitized-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ADR 0001: Independent sanitized history

- Status: Accepted
- Date: 2026-10-20

## Context

The completed client implementation is proprietary and cannot be copied or mirrored into OSYSTIC portfolio repositories.

## Decision

Maintain this public repository as an independently authored documentation-only case study. Do not import Git history, source, assets, screenshots, evidence captures or task identifiers from the confidential project.

## Consequences

The public artifact remains safe to share, but it cannot reproduce the confidential implementation. Claims must remain capability-level and evidence-backed.
21 changes: 21 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Sanitized Architecture

Configuration / validation inputs
|
v
Deterministic simulation & geometry core
|
+--------------------+
| |
v v
Native Unreal integration GPU rendering path
| |
+---------+----------+
|
v
Runtime presentation
|
v
Tests + runtime evidence checks

Proprietary class names, source layout, exact parameters, private topology, task IDs and client assets are omitted.
22 changes: 22 additions & 0 deletions docs/disclosure-boundary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Disclosure Boundary

## Safe for this public repository

- generic capability descriptions;
- sanitized architecture;
- public technology names;
- generalized validation methodology;
- evidence-backed statements that two workstreams were completed.

## Not safe for this public repository

- client/company identity;
- client repository or PR URLs;
- task identifiers or internal naming;
- source code, headers, shaders or build artifacts;
- screenshots, videos or raw evidence from the client project;
- session logs;
- exact proprietary acceptance thresholds;
- commercial terms or private conversations.

Any future addition must be reviewed against this boundary before merge.
11 changes: 11 additions & 0 deletions docs/handover.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Showcase Handover

This repository is documentation-only and has no runtime deployment.

Maintenance responsibilities:

- keep the repository manifest current;
- preserve the disclosure boundary;
- ensure public claims remain traceable to private verified evidence;
- do not add client source or artifacts;
- remove or correct claims if their evidence or publication permission changes.
8 changes: 8 additions & 0 deletions docs/lessons-learned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Engineering Lessons

- Separate deterministic logic from engine orchestration. It improves testability and reduces dependence on manual editor inspection.
- Validate renderer outcomes independently. A good-looking frame can still hide topology or GPU-readback mistakes.
- Treat visual polish as part of acceptance. Functional correctness and shipped-quality presentation are different gates.
- Use configuration-driven validation. Repeatable poses and parameters make review more auditable.
- Keep evidence tied to exact delivered commits. This prevents documentation from drifting away from what was actually reviewed.
- Maintain a hard public/private boundary. A strong case study does not require publishing client code or screenshots.
25 changes: 25 additions & 0 deletions docs/publication-record.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Publication Record

- Artifact: osystic/unreal-native-rendering-simulation-case-study
- Artifact type: sanitized public engineering case study
- Source basis: verified completed proprietary client delivery
- IP/contract treatment: client source excluded; no mirroring or reuse of protected artifacts
- Sanitization review: OSYSTIC publication review, AI-assisted, 2026-10-20
- Founder approval: Shawaiz Arif, 2026-10-20
- Approved channels: OSYSTIC GitHub public portfolio and website case-study review queue
- Client identity: not approved for publication / not included
- Metrics: no client-specific numerical performance or acceptance metrics published
- Withdrawal owner: OSYSTIC

## Sanitization checks

- [x] Client identity removed
- [x] Client repository URLs removed
- [x] Internal task IDs removed
- [x] Source code excluded
- [x] Client screenshots/video excluded
- [x] Session logs excluded
- [x] Credentials/endpoints excluded
- [x] Commercial data excluded
- [x] Claims limited to verified capability-level outcomes
- [x] Independent public Git history
13 changes: 13 additions & 0 deletions docs/runbook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Public Showcase Runbook

Before changing this repository:

1. Open an issue describing the intended public claim or artifact.
2. Confirm the change can be supported by the private evidence record.
3. Do not copy from the client repository.
4. Re-run the public-safety workflow.
5. Review the disclosure boundary.
6. Obtain founder approval for any new claim, metric, screenshot, identity, demo, or publication channel.
7. Merge through a pull request only after checks pass.

If confidentiality is uncertain, leave the information out.
21 changes: 21 additions & 0 deletions docs/technical-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Technical Overview

## Native simulation

Mechanical behavior was treated as a deterministic systems problem rather than an animation-only problem. The architecture separated calculable relationships from engine lifecycle and presentation concerns, making important invariants easier to validate.

## Section visualization

Section rendering combined runtime scene integration with GPU-side visualization. Validation was designed to confirm meaningful geometry/render outcomes rather than accepting a visually plausible screenshot as proof.

## Validation philosophy

The delivery used layered verification:

1. fast portable regression where logic could be tested outside the engine;
2. exact-engine build validation;
3. runtime/GPU checks for behavior that only exists in the renderer;
4. visual review for presentation quality; and
5. evidence packaging for independent client review.

This public document omits private implementation detail.
19 changes: 19 additions & 0 deletions docs/validation-evidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Validation Evidence

## Verified privately

The confidential delivery record supports the following public-safe statements:

- two distinct Unreal Engine workstreams were completed and submitted;
- the required engine version was Unreal Engine 5.8.3;
- native C++ implementation was used;
- GPU shader/rendering work was used for the section-visualization capability;
- automated regression checks were part of delivery;
- runtime validation and visual evidence were part of review;
- final work existed on client-controlled remote task branches and pull requests at closeout.

## Intentionally not published

Client repository URLs, task IDs/titles, commit SHAs, source/diffs, exact acceptance thresholds, runtime screenshots/videos, session logs, proprietary geometry/assets, client/supervisor identities, and commercial information are excluded.

The absence of those artifacts is a confidentiality control, not a lack of verification.
Loading