Welcome to the documentation for Eye of the Nile - GameDev at UMass Lowell's main project from Fall 2023 to Spring 2025!

Here you will find all you need to know about the underlying systems this game runs on. Every script, prefab, scene, scriptable object, and more is documented here automatically, giving you easy access to all the information you need to start developing!

This page is automatically generated using Doxygen, which takes code comments formatted in a specific way and creates an HTML page that's easy to read and navigate. Whether you're confused on how a script or system works or just need to reference a specific variable name, this page is very helpful. It's worth noting this automatic updating only applies to the scripts (any file that ends in .cs), and anything else is still manually documented.

There's also some very helpful Detailed Explanations for multiple complicated systems! Please check them out if you're ever confused about a larger system as a whole.

When you write your own scripts or edit pre-existing ones, it's very appreciated if you write similar comments (or at least comments in general) to the ones found in the rest of the scripts. Explain the functionality and purpose of each variable, function, and script you make. It's not as important that you follow the correct syntax (I can always reformat it later to fit what Doxygen wants), as long as the information is there. If you do want to format it properly, use the other scripts as an example or reference the Doxygen documentation (https://www.doxygen.nl/manual/).

If you have any questions, feel free to ask in the Discord!

Author: Stephen Nuttall - President (Fall 2023 - Spring 2025)