Book Structure


Root folders

  • .github - For GitHub.
  • .vscode - For VSCode specific files.
  • assets - Static layout of icons of various programs for easy use across tutorials, articles, etc.
  • dist - Contains a compiled version of mdbook for quick local verification.
  • src - Source Folder.
  • theme - Various additional files for the book and preprocessors.

Src folder

Different types of technical documentation are used in this book. They are described below.

Engine

This is engine related Code и API Documentation.

Script

This is script related Code Documentation.

Glossary

Glossary

Meta

General info

Modding tools

Software Documentation.

Reference

Reference Documentation. The user can quickly check the information they need.

Resources

Resources Documentation.

Tutorials

This is User Documentation. It stores various tutorials.