How mar-7th/starrailres works
Main Components
• Resource Assets:
• Image Folder: Contains various game images including character portraits, previews, and simulated event images.
• Guide Folder: Contains tutorial images which may assist in understanding or utilizing the resource data.
• Index Files:
• index_new: Holds the detailed and current game data in a language-specific structure. Each language subdirectory (e.g., en, cn, jp, etc.) comprises various JSON files for paths, elements, characters, skills, promotions, relics, and items.
• index_min: Holds compressed versions of the same indexes for potentially lighter-weight use cases.
• Metadata and Configurations:
• info.json and other files like LICENSE, .gitignore, README.md, which explain the project and provide guidelines and meta-information.
• External References:
• Link to the Dimbreath/StarRailData repository, indicating the project’s external data source for game data. This source information might be noted externally or as a dependency.
Relationship and Interaction Representation
• Index_new and index_min as nodes that “reference” or “point to” data used throughout the application. Each language subdirectory within these indexes can be abstracted as components containing specific JSON files. You might consider grouping these JSON files under a “Language Node” where you list items such as:
– paths.json (命途)
– elements.json (元素)
– properties.json (属性)
– characters.json (角色基本信息)
– character_ranks.json, character_skills.json, character_promotions.json, etc.
– light_cone and relic related JSON files.
Architectural Patterns and Design Principles
• Separation of static assets from dynamic content, even though all resources are file-based.
• Structured approach to localization: having directories in both index_new and index_min segregated by language clearly shows the support for multiple locales.
Relevant Technologies, Frameworks, or Libraries
• Primarily, the project revolves around JSON data and static assets. While there’s no runtime backend indicated, note the use of JSON for structured data, which may later be consumed by other tools or applications.
• Mention that since it’s a static repository, any integration with external systems (for example, frontends that display these resources) would treat these folders as consistent, read-only data sources.
Essential Elements to Incorporate
• Clear labels on every node (asset folders, index directories, individual language subdirectories, meta files).