Documentation Articles

[Chris3606]

GoRogue 3's documentation page has a number of "how-to" articles intended to explain and demonstrate various features:

• Component System: Explain usage of the GoRogue component system
• Dice Rolling: Explain usage of the dice notation parser
• Effects System: Explain usage of the Effects system to implement game mechanics
• Factory System: Explain usage of Factory and AdvancedFactory, with both lambda-based and custom blueprints
• Field of View: Demonstrate usage of GoRogue's field of view system (both existing algorithms and creation of custom ones)
• Game Framework: Explain the GoRogue.GameFramework namespace, including what GoRogue features it integrates as well as its limitations compared to the rest of the library
• Grid View Concepts: Explain concepts of grid views and how they pertain to GoRogue algorithms
• Map Generation: Explain usage of the map generation framework (both using existing algorithms and creating custom ones)
• Message Bus: Demonstrate the purpose and usage of GoRogue's message bus structure
• Pathfinding: Explain usage of GoRogue's pathfinding algorithms, including A*, goal maps, and flee maps
• Random Number Generation: Explain ShaiRandom's usage and typical conventions used by GoRogue algorithms which use random number generation
• Sense Maps: Explain the usage of GoRogue's "sense map" system, including usage of existing sources and sense maps, the creation of custom source algorithms, and customization of the sense map itself
• Serialization: Provide guidelines for using GoRogue with common serialization frameworks such as Newtonsoft.JSON or System.Json

Articles should use the code snippets system built into docfx to ensure that their code continues to compile if the library changes. This has already been done for existing articles; so implementing this portion should simply be a matter of ensuring code snippets for future articles continue to abide by this.