Meggie's Final Project Design Doc

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,39 @@
+
+
+name: Build and Deploy
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-node@v2-beta
+        with:
+          node-version: "15.x"
+
+      - uses: actions/cache@v2
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install and Build 🔧
+        run: |
+          npm ci
+          export NODE_ENV=production
+          npm run-script build
+          touch dist/.nojekyll
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: dist
+          CLEAN: false

.gitignore

@@ -0,0 +1,61 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

INSTRUCTIONS.md

@@ -0,0 +1,117 @@
+# Final Project!
+
+This is it! The culmination of your procedural graphics experience this semester. For your final project, we'd like to give you the time and space to explore a topic of your choosing. You may choose any topic you please, so long as you vet the topic and scope with an instructor or TA. We've provided some suggestions below. The scope of your project should be roughly 1.5 homework assignments). To help structure your time, we're breaking down the project into 4 milestones:
+
+## Milestone 1: Project planning (due 11/15)
+Before submitting your first milestone, _you must get your project idea and scope approved by Rachel, Adam or a TA._
+
+### Design Doc
+Start off by forking this repository. In your README, write a design doc to outline your project goals and implementation plan. It must include the following sections:
+
+#### Introduction
+- What motivates your project?
+
+#### Goal
+- What do you intend to achieve with this project?
+
+#### Inspiration/reference:
+- You must have some form of reference material for your final project. Your reference may be a research paper, a blog post, some artwork, a video, another class at Penn, etc.  
+- Include in your design doc links to and images of your reference material.
+
+#### Specification:
+- Outline the main features of your project.
+
+#### Techniques:
+- What are the main technical/algorithmic tools you’ll be using? Give an overview, citing specific papers/articles.
+
+#### Design:
+- How will your program fit together? Make a simple free-body diagram illustrating the pieces.
+
+#### Timeline:
+- Create a week-by-week set of milestones for each person in your group. Make sure you explicitly outline what each group member's duties will be.
+
+Submit your Design doc as usual via pull request against this repository.
+## Milestone 2: Implementation part 1 (due 11/22)
+Begin implementing your engine! Don't worry too much about polish or parameter tuning -- this week is about getting together the bulk of your generator implemented. By the end of the week, even if your visuals are crude, the majority of your generator's functionality should be done.
+
+Put all your code in your forked repository.
+
+Submission: Add a new section to your README titled: Milestone #1, which should include
+- written description of progress on your project goals. If you haven't hit all your goals, what's giving you trouble?
+- Examples of your generators output so far
+We'll check your repository for updates. No need to create a new pull request.
+## Milestone 3: Implementation part 2 (due 11/29)
+We're over halfway there! This week should be about fixing bugs and extending the core of your generator. Make sure by the end of this week _your generator works and is feature complete._ Any core engine features that don't make it in this week should be cut! Don't worry if you haven't managed to exactly hit your goals. We're more interested in seeing proof of your development effort than knowing your planned everything perfectly. 
+
+Put all your code in your forked repository.
+
+Submission: Add a new section to your README titled: Milestone #3, which should include
+- written description of progress on your project goals. If you haven't hit all your goals, what did you have to cut and why? 
+- Detailed output from your generator, images, video, etc.
+We'll check your repository for updates. No need to create a new pull request.
+
+Come to class on the due date with a WORKING COPY of your project. We'll be spending time in class critiquing and reviewing your work so far.
+
+## Final submission (due 12/6)
+Time to polish! Spen this last week of your project using your generator to produce beautiful output. Add textures, tune parameters, play with colors, play with camera animation. Take the feedback from class critques and use it to take your project to the next level.
+
+Submission:
+- Push all your code / files to your repository
+- Come to class ready to present your finished project
+- Update your README with two sections 
+  - final results with images and a live demo if possible
+  - post mortem: how did your project go overall? Did you accomplish your goals? Did you have to pivot?
+
+## Topic Suggestions
+
+### Create a generator in Houdini
+
+### A CLASSIC 4K DEMO
+- In the spirit of the demo scene, create an animation that fits into a 4k executable that runs in real-time. Feel free to take inspiration from the many existing demos. Focus on efficiency and elegance in your implementation.
+- Example: 
+  - [cdak by Quite & orange](https://www.youtube.com/watch?v=RCh3Q08HMfs&list=PLA5E2FF8E143DA58C)
+
+### A RE-IMPLEMENTATION
+- Take an academic paper or other pre-existing project and implement it, or a portion of it.
+- Examples:
+  - [2D Wavefunction Collapse Pokémon Town](https://gurtd.github.io/566-final-project/)
+  - [3D Wavefunction Collapse Dungeon Generator](https://github.com/whaoran0718/3dDungeonGeneration)
+  - [Reaction Diffusion](https://github.com/charlesliwang/Reaction-Diffusion)
+  - [WebGL Erosion](https://github.com/LanLou123/Webgl-Erosion)
+  - [Particle Waterfall](https://github.com/chloele33/particle-waterfall)
+  - [Voxelized Bread](https://github.com/ChiantiYZY/566-final)
+
+### A FORGERY
+Taking inspiration from a particular natural phenomenon or distinctive set of visuals, implement a detailed, procedural recreation of that aesthetic. This includes modeling, texturing and object placement within your scene. Does not need to be real-time. Focus on detail and visual accuracy in your implementation.
+- Examples:
+  - [The Shrines](https://github.com/byumjin/The-Shrines)
+  - [Watercolor Shader](https://github.com/gracelgilbert/watercolor-stylization)
+  - [Sunset Beach](https://github.com/HanmingZhang/homework-final)
+  - [Sky Whales](https://github.com/WanruZhao/CIS566FinalProject)
+  - [Snail](https://www.shadertoy.com/view/ld3Gz2)
+  - [Journey](https://www.shadertoy.com/view/ldlcRf)
+  - [Big Hero 6 Wormhole](https://2.bp.blogspot.com/-R-6AN2cWjwg/VTyIzIQSQfI/AAAAAAAABLA/GC0yzzz4wHw/s1600/big-hero-6-disneyscreencaps.com-10092.jpg)
+
+### A GAME LEVEL
+- Like generations of game makers before us, create a game which generates an navigable environment (eg. a roguelike dungeon, platforms) and some sort of goal or conflict (eg. enemy agents to avoid or items to collect). Aim to create an experience that will challenge players and vary noticeably in different playthroughs, whether that means procedural dungeon generation, careful resource management or an interesting AI model. Focus on designing a system that is capable of generating complex challenges and goals.
+- Examples:
+  - [Rhythm-based Mario Platformer](https://github.com/sgalban/platformer-gen-2D)
+  - [Pokémon Ice Puzzle Generator](https://github.com/jwang5675/Ice-Puzzle-Generator)
+  - [Abstract Exploratory Game](https://github.com/MauKMu/procedural-final-project)
+  - [Tiny Wings](https://github.com/irovira/TinyWings)
+  - Spore
+  - Dwarf Fortress
+  - Minecraft
+  - Rogue
+
+### AN ANIMATED ENVIRONMENT / MUSIC VISUALIZER
+- Create an environment full of interactive procedural animation. The goal of this project is to create an environment that feels responsive and alive. Whether or not animations are musically-driven, sound should be an important component. Focus on user interactions, motion design and experimental interfaces.
+- Examples:
+  - [The Darkside](https://github.com/morganherrmann/thedarkside)
+  - [Music Visualizer](https://yuruwang.github.io/MusicVisualizer/)
+  - [Abstract Mesh Animation](https://github.com/mgriley/cis566_finalproj)
+  - [Panoramical](https://www.youtube.com/watch?v=gBTTMNFXHTk)
+  - [Bound](https://www.youtube.com/watch?v=aE37l6RvF-c)
+
+### YOUR OWN PROPOSAL
+- You are of course welcome to propose your own topic . Regardless of what you choose, you and your team must research your topic and relevant techniques and come up with a detailed plan of execution. You will meet with some subset of the procedural staff before starting implementation for approval.