Repository navigation
Technical Documentation
LouisMNI edited this page Jan 31, 2024
·
4 revisions
- Game Engine: Godot
- Programming Language: GDScript (Note: Godot also supports other languages like C# and VisualScript, but in this case, GDScript was used.)
- The main programming language is GDScript.
-
Local Storage: The app stores data in the default app directory on iOS and Android.
- iOS: /var/mobile/Containers/Data/Application/MESSAG/Documents
- Android: /data/data/MESSAG
The architectural pattern of this project is based on the Entity-Component-System (ECS), which Godot frequently uses for structuring games. ECS allows for a clear and modular organization of entities, components, and systems.
-
Entities:
- Each playable object in the game is represented by an entity. Entities are containers that can hold various components.
-
Components:
- Components are standalone modules that represent specific functionalities or data. Each component can be developed, tested, and reused independently of other components.
-
Systems:
- Systems are behavioral modules that operate on entities with specific components. They control the update and interactions of entities in the game.
-
Entities:
- Each entity, such as the player, a spaceship, or a shop, has its own script containing the specific logic and interactions for that entity.
-
Components:
- Components are organized in individual scripts to ensure their independence. For example, the
PlayerInputcomponent has its own script that focuses exclusively on processing user input.
- Components are organized in individual scripts to ensure their independence. For example, the
-
Systems:
- Systems are implemented as separate scripts or classes. Each system acts on entities with specific components. For example, the
PlayerMovementSystemcontrols the movement of entities that have thePlayerInputandCharacterControllercomponents.
- Systems are implemented as separate scripts or classes. Each system acts on entities with specific components. For example, the
-
Flexibility:
- Entities can be dynamically assembled with different components, increasing flexibility in creating new objects in the game.
-
Reusability:
- Components can easily be reused in different entities, simplifying development and maintenance.
-
Clear Separation of Responsibilities:
- The clear structure of entities, components, and systems makes it easy to identify responsibilities and make changes.
The ECS architecture enables efficient and scalable development in the context of game development in Godot.
-
Continuous Integration (CI):
- In our CI pipeline, we rely on GitHub Actions. A CI pipeline is automatically triggered with each pull request. The CI pipeline includes steps for code compilation.
-
Continuous Deployment (CD):
- The CD process is triggered upon successful completion of the CI pipeline. The CD system automatically builds .apk files for Android and the iOS equivalent. Specific steps are required for deploying on iOS, including signing the app for release. The generated artifacts are placed in a designated directory accessible to developers.
-
Access Control and Data Security:
- As the app operates locally and does not require a persistent internet connection, access control and data security primarily lie in the hands of the end user and the device.
- It's crucial to ensure that locally stored data, especially sensitive user information, is appropriately encrypted to prevent unauthorized access.
-
Permissions and App Sandboxing:
- On mobile operating systems like iOS and Android, the app is typically confined to a sandbox environment, limiting access to specific device resources and functions.
- Ensure that the app only requests and uses necessary permissions to respect user privacy.
-
User Data Privacy:
- The app does not collect or store any personally identifiable information.
- Since the app operates locally, no information is transmitted to external servers.
-
Known Security Issues:
- Currently, there are no known security issues. However, note that local security depends directly on the security features of the operating system and permissions.
- We have not used any external APIs or services.