Developer Guide - jackspaceBerkeley/pupil GitHub Wiki

Pages in the developer guide are oriented towards developers and will contain high level overview of code and organizational structure.

If you want to develop a plugin or to extend Pupil for your project, this is the place to start.

These pages will not contain detailed documentation of code. We're working on code documentation, and when it's done we will put code documentation online at read the docs.

If you have questions, encounter any problems, or want to share progress -- write a post on the Pupil Google Group. We will try our best to help you out, and answer questions quickly.

1. [Development Overview](Development Overview) - Overview of Language, Code Structure, and General Conventions.
2. Language
3. Process Structure 1. Eye Process 1. World Process 1. Inter Process Communication (IPC)
   1. Pupil Queue
   2. Control: World -> Eye
   3. Quit
4. Timing and Data Conventions
5. Git Conventions 1. Branches 1. Issues
6. [Plugin Guide](Plugin Guide) - Overview of plugin structure, existing plugins, and how to make your own plugins.
7. World Process Plugins
8. Pupil Player Plugins
9. Plugin Class Template
10. Making Your Own Plugin
11. [Pupil Hardware Development](Pupil Hardware Development) - Documentation and discussion on open-source camera mounts, optics, and cameras.
12. Camera Mounts