How sekodev/openbilgi works
Project type and purpose
• This is a cross-platform trivia/quiz game (“OpenBilgi”) built on the Solar2D engine (formerly Corona SDK).
• Its purpose is to present question sets (in multiple languages), manage game states (menu, game, success, end, stats, etc.), play music/sound effects, and record preferences/stats.
File structure
• Top-level files: build.settings, config.lua, main.lua (entry point), README, license files.
• libs/: reusable Lua modules (composer_alt, preference, rng, commonMethods, utils, translations, etc.).
• screens/: one Lua file per Composer scene (menuScreen.lua, gameScreen.lua, creditScreen.lua, etc.).
• questions/: language-specific questionSetX.lua files.
• storeFiles/: marketing assets for Google Play (screenshots, banners) and legal docs (privacyPolicy, termsUse).
• translations/: top-level language mappings (en.lua, tr.lua).
README for additional insights
• Confirms dependency on Solar2D runtime v2024.3710.
• Lists external libraries: Pseudorandom Number Generator, Preference, sozluk (dictionary).
• Details asset licenses (music, SFX, font).
Main components
a. Solar2D Engine (runtime)
b. Application Core
• main.lua & config.lua (initialization & config)
• build.settings (platform settings)
c. Scene Manager
• composer_alt (wrapper over Composer API)
• screens/* (menuScreen, gameScreen, etc.)
d. Game Logic & Data
• libs/ (core modules: RNG, preference, commonMethods, utils)
• questions/ (localized question sets)
• translations/ (text localization)
e. Asset Layer
• assets/ (audio, images, particleFX)
f. External Services & Marketing
• storeFiles/ (Google Play images, privacy policy, terms)
• (future extension point for ads or analytics)
Relationships & interactions
• The Solar2D Engine loads main.lua → reads config → invokes Scene Manager.
• Scene Manager uses composer_alt to transition between screens.
• Each screen requests data from Game Logic modules (questions, translations, RNG, preference).
• Assets (audio/images/particleFX) are loaded on demand by screens.
• Preference library persists settings & stats.
• On build, build.settings + platform resources configure packaging for iOS/Android.
• storeFiles are only used at release time for marketing.
Architectural patterns & design principles
• Layered architecture: Engine → Application Core → Scene Management → Business Logic → Assets/Data.
• Separation of concerns: UI (screens) vs. logic (libs) vs. data (questions/translations) vs. resources.
• Plugin-style extensibility: new libs or question sets can be dropped into directories.
• Localization through file-based translation modules.
• Startup sequence
• Scene transitions
• Data requests (question fetch, translation lookup)
• Asset loads (audio, images, particleFX)
• Persistence actions (preference writes/reads)
• Modules with their file paths (e.g., libs/preference.lua).
• Every file group (screens, libs, questions, assets) is represented as a logical component.