Developer docs
Here are all the docs for developers and designers. The docs are always WIP please report any error or requests for details (on Discord or via GitHub issue).
The repository of this project is: https://github.com/vgwb/Antura
Discover Quests
To create a new Quest Design Discover Quests
Game Design
HowTo
User and Tester guides
- Debug Shortcuts cheats and keyboard shortcuts
- Export Database how to export player databases
Developer guides
- Install how to install and configure the Unity project
- Build how to build the app for mobile devices
- Create Edition
- Collaborator how to collaborate
- Developer Guidelines and Tips general guidelines for developers that want to contribute to the project
- Refactoring Guidelines
- Export Google Sheet Data as JSON files
- Drawing Font how to create the drawings font Atlas with TextMeshPro
- How To regenerate DoxyGen docs
Core Modules / Architecture
- Project Structure the structure of the Unity project.
- Application Flow the complete flow of the application, useful if you want to understand the call flow.
- Antura and LivingLetters
- Arabic Rendering
- Database the datasets used everywhere.
- Database Schemas details on db tables and schemas
- Database Management
- Data Flow how the learning content data flows from the database, to the teacher system, and finally to minigames.
- Journey
- Localization
- Logging the implementation and use of the Logging System.
- MiniGame how a MiniGame works, how to create new ones and link them to the core application.
- Player Profile how the Player Profile Manager works, a subsystem that allows the use of several profiles on the same device.
- Shaders the list of shaders used in this project.
- Teacher AI how the Teacher System works. This subsystem is responsible for providing learning content data to the minigames.
- Analytics the implementation and use of the Logging System.