SakeScript Format Specification
SakeScript is a structured file format for the SakeSaySo language learning app. It facilitates the packaging and distribution of learning materials, such as stories and articles in a portable manner.
SakeScript
How to contribute to the community repository
SakeSaySo’s iOS and Android applications are designed to support custom content creation. Our content, including articles, stories, and dialogues, is structured in the SakeScript format. SakeScript bundles a manifest, a JSON file for content, and any optional assets like images into a zip archive, simplifying content portability. The app indexes the manifest, thus creating a searchable and engaging user experience.
Import Options:
- Community Repository: The simplest method to share your stories is via the community GitHub repository. This repository is pre-configured in the app, allowing your content to benefit from and contribute to the community. Merging a pull request into this repository triggers an automated GitHub action, updating the search index in the app.
- Custom Repository: Add a personal story library under
Settings -> Advanced Settings -> Add Repository. For details, visit Custom Repositories. - App Imports: In the app, navigate to the stories page, tap the
+button at the top right, and select a SakeScript.zipfile.
Export Method:
To share a story from the app, first open the story, then navigate to the story info page, and finally tap the share button.
Flash Card Deck Format
The SakeScript format for the SakeSaySo language learning app facilitates the packaging and distribution of learning materials, including flash cards for spaced repetition learning of vocabulary, sentences and phrases.
Import and Export SakeScript Stories
SakeSaySo is designed with sharing, collaboration and open formats in mind. Our story, article and learning format SakeScript is open and welcomes contributors.
Custom Repositories
How to contribute to the community repository
GitHub Actions for Daily News Aggregation
Supporting the trend of content generation with LLMs, this page shows how we’re using GitHub Actions with our Go scripts to create daily translated news in one of our community repositories.