Scotty3D is the 3D modeling, rendering, and animation package that students complete as part of 15-462/662 Computer Graphics at Carnegie Mellon University.
The current version of the starter code is available at https://github.com/CMU-Graphics/Scotty3D .
User documentation and example works are available at https://cmu-graphics.github.io/Scotty3D-docs/ .
Please do not use a public GitHub fork of this repository! We do not want solutions to be public. You should work in your own private repo. We recommended creating a mirrored private repository with multiple remotes. The following steps go over how to achieve this.
The easiest (but not recommended) way is to download a zip from GitHub and make a private repository from that. The main disadvantage with this is that whenever there is an update to the base code, you will have to re-download the zip and manually merge the differences into your code. This is a pain, and you already have a lot to do in 15462/662, so instead, let
git take care of this cumbersome "merging-updates" task:
Clone Scotty3D normally
git clone https://github.com/CMU-Graphics/Scotty3D.git
Create a new private repository (e.g.
- Do not initialize this repository - keep it completely empty.
- Let's say your repository is now hosted here:
Ensure that you understand the concept of
remotes in git.
- When you clone a git repository, the default remote is named 'origin' and set to the URL you cloned from.
- We will set the
origin of our local clone to point to
MyScotty3D.git, but also have a remote called
sourcerepo for the public
Now go back to your clone of Scotty3D. This is how we add the private remote:
- Since we cloned from the
CMU-Graphics/Scotty3D.git repository, the current value of
origin should be
- You can check this using
git remote -v, which should show:
origin https://github.com/CMU-Graphics/Scotty3D.git (fetch)
origin https://github.com/CMU-Graphics/Scotty3D.git (push)
git remote rename origin sourcerepo
- Add a new remote called
git remote add origin https://github.com/your_id/MyScotty3D.git
- We can now push the starter code to our private copy:
git push origin -u main
Congratulations! you have successfully mirrored a git repository with all past commits intact.
Now, let's see why this setup may be useful: say we start doing an assignment and commit regularly to our private repo (our
origin). Then the 15-462 staff push some new changes to the Scotty3D skeleton code that we want to pull in. But, we don't want to mess up the changes we've added to our private copy. Here's where git comes to the rescue:
git pull sourcerepo main- this pulls all the changes from
sourcerepointo your local copy. - If there are files with changes in both
sourcerepo, git will attempt to automatically merge the updates. Git may create a "merge" commit for this. - Unfortunately, there may be conflicts. Git will handle as many merges as it can, then then tell you which files have conflicts that need manual resolution. You can resolve the conflicts in your text editor and create a new commit to complete the
git push origin main
Run, from a command prompt that has your compiler available:
#change to the directory with the repository: $ cd Scotty3D #use Maek to build the code: Scotty3D$ node Maekfile.js #run the UI: Scotty3D$ ./Scotty3D #run the tests: Scotty3D$ ./Scotty3D --run-tests
Note that you should read
Maekfile.js. about the available command line options and how to configure your own build. All the code has been nicely documented to help you understand the building process and reinforce your learning.
git pull to make sure you have the latest handout version. We'll let you know when to do this, but generally you should pull before starting on a new assignment (e.g. when you switch from A1 to A2).
More info about Scotty3D can be found in the User Guide (and again,
Maekfile.js!). We will also post on Piazza if there's an update you should be aware of. Make sure you have access to these, and don't hesitate to ask questions!
Table of Content