SakeSaySo Community Repository

Welcome to the SakeSaySo Community Repository, the official place for user-contributed content for the SakeSaySo app. Here, every word is a sip towards fluency. Kanpai to our Japanese language adventure!

Contribute SakeScript

Your contributions are the essence of our community's growth and learning. We encourage you to share your unique insights and experiences with the SakeSaySo audience. Here's how you can contribute:

• Familiarize with SakeScript: Before submitting your content, please review the SakeScript Format Specification. This ensures your contributions align seamlessly with the SakeSaySo app's structure and style.
• Create and Share: Craft your SakeScript content.
• Submit a Pull Request: Once ready, submit it via a pull request for the community to enjoy.

Directory Layout

This repository is currently organized into the sections fiction and non-fiction for stories and we've recently added jlpt for sharing flash card resources. Story based content contains a range of categories represented by the story manifest files' first specific tag from the SakeScript spec. Each resource is available both as individual files and a portable ZIP archive. Below is an overview of the current directory structure:

.
├── jlpt/                 # or toeic, standardized type learning resources
│   ├── n2
│   │   ├── main.txt      # Vocabulary list for JLPT N2
│   │   └── manifest.json
│   └── n2.zip
├── fiction/
│   ├── adv/              # Adventure and exploration themed stories
│   ├── sfi/              # Science fiction and futurism themed stories
│   │   ├── [uuid]/       # Individual story files
│   │   │   ├── cover.jpg
│   │   │   ├── main.json
│   │   │   └── manifest.json
│   │   └── [uuid].zip    # Corresponding SakeScript ZIP archive
│   └── ...               # Other fictional categories
└── non-fiction/
    ├── pol/              # Politics and society themed stories
    ├── tec/              # Technology and internet themed stories
    │   ├── [uuid]/       # Individual story files
    │   │   ├── cover.jpg
    │   │   ├── main.json
    │   │   └── manifest.json
    │   └── [uuid].zip    # Corresponding SakeScript ZIP archive
    └── ...               # Other non-fiction categories

File Naming and Format

• ZIP Files: Each ZIP file is named using a unique identifier (UUID) specific to the story.
• Raw Files: Within each story's directory (identified by UUID), you will find individual files. These include optionally cover.jpg and mandatory JSON files in v1.0: main.json and manifest.json.
• Cover Image: We recommend using JPEG format for cover images to minimize file size. To convert a PNG image from e.g. DALL·E to JPEG, you can use ImageMagick with the following command: convert cover.png -resize 1080x -quality 92 cover.jpg.

Example Story Addition

Select a story category and create a new unique identifier, then copy a skeleton from a different story and start writing:

cd non-fiction/biz
# create a new uuid for this story
uuidgen
E6D2BDE7-F015-4629-BB59-072E1B6A091D
mkdir E6D2BDE7-F015-4629-BB59-072E1B6A091D
cd E6D2BDE7-F015-4629-BB59-072E1B6A091D
cp ../../../non-fiction/tec/1A86F3E6-C41F-4B9B-B6F7-040E25AF20CB/*.json .
# edit the files
zip -r ../E6D2BDE7-F015-4629-BB59-072E1B6A091D.zip .

Licensing

All contributions to this repository, unless otherwise noted, are licensed under the Creative Commons Attribution-ShareAlike license. This means:

• Indulge and Remix: Feel free to use, adapt, and build upon the contributed works.
• Attribute and Share: When using others' contributions, give credit and share your enhancements under the same terms.