Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

this is a TEST of update from TD #20

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/diagram.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Create diagram
on:
workflow_dispatch: {}
push:
branches:
- main
jobs:
get_data:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@master
- name: Update diagram
uses: githubocto/repo-visualizer@main
with:
excluded_paths: "ignore,.github"
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# A door opens from touchdesigner to here
# A door opens from touchdesigner to here
# A door opens from touchdesigner to here
# @heymaslo/persona

![Visualization of this repo](./diagram.svg)

![](https://cdn-images-1.medium.com/max/1600/1*Gm7A7w4vJZeNXKHJQxhq7Q.gif)


Expand All @@ -12,7 +17,7 @@ https://storage.googleapis.com/maslomemory/m2/index.html?color=30

## Persona Module/Computational Being

Think of the persona as the companion's ‘face’.
Think of the persona as the companion's ‘face’.

This persona consists of multiple properties (ie: size, speed, brightness, complexity, color, etc) that change based on user inputs and interaction. Every user can have a unique persona and their persona will evolve over time.

Expand Down Expand Up @@ -113,10 +118,10 @@ You will want to read the face-api js docs below. Make sure you have the models

## Structure

1. `lib` here lives ES6 classes with meaningful JSDoc comments for Maslo Persona core code. Not ready for rendering, requires further integration to a rendering scene, but all core logic is placed here including usage of Three.js, gsap, mobx.
2. `web` a HTML/WebGL renderer for Maslo Persona that is ready to be placed right in HTML project with minimal additional configuration.
3. `webdemo` Basically the only runnable (and main for now) one here, single page site based on webpack dev server that uses `web` package for Persona rendering.
4. [TODO] `react-native` renderer for RN. Please make a request if you want this sooner and we will prioritize.
1. `lib` – here lives ES6 classes with meaningful JSDoc comments for Maslo Persona core code. Not ready for rendering, requires further integration to a rendering scene, but all core logic is placed here including usage of Three.js, gsap, mobx.
2. `web` – a HTML/WebGL renderer for Maslo Persona that is ready to be placed right in HTML project with minimal additional configuration.
3. `webdemo` – Basically the only runnable (and main for now) one here, single page site based on webpack dev server that uses `web` package for Persona rendering.
4. [TODO] `react-native` – renderer for RN. Please make a request if you want this sooner and we will prioritize.

## How To Use

Expand Down Expand Up @@ -163,7 +168,7 @@ persona.stop();
// or manually update it every frame
persona.step();

// resize react to screen dimensions changes (not really required by now, but may be so in future)
// resize – react to screen dimensions changes (not really required by now, but may be so in future)
persona.resize();

// Working with Persona itself:
Expand Down Expand Up @@ -260,4 +265,4 @@ When contributing to this repository, please first discuss the change you wish t

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
1 change: 1 addition & 0 deletions diagram.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.