Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 4.17 KB

README.md

File metadata and controls

71 lines (52 loc) · 4.17 KB

Kobo Button

Kobo Button is unofficial and fan made website to play audio clip of Kobo Kanaeru. The types of audio available are words said by Kobo, sounds such as laughing and sneezing, and songs.

⚠️ The audio is taken and presented without any additional context. This website and its contents should not be used as a judgement to any mentioned or related party.

Setting up

  1. This repo or the build tool doesn't include a server so you need to install a server first if you don't have any. You can find some in npm and install it globally. Something like built-in server in python or php also works.
  2. Install packages
  3. Copy .env.example and rename it to .env. Modify APP_URL as per your requirement.
  4. Run server and serve the project root.
  5. Run npm run watch and go to [APP_URL]lang/en.html or you can skip and do translation or add audio as in the steps below.

Making change and Contributing

After running npm run watch from setting up above you can do local development by modify src/index.ejs, src/style.css, or src/script.js.

If you want to do a contribution you have to fork this repo first and then do the setting up above. Before you commit and make a pull request please don't forget to run npm run build.

Add or Edit Translation

You can add or improve a translation file to make this website more accessible and spread the Kobo audio clip to wider audience.

  1. If you want to add a translation, copy any translation file in lang/ and rename the file. The file name have to be a valid language code for lang HTML attribute. (ref. 1, ref. 2)
  2. Run npm run watch -- [language code], e.g., npm run watch -- id if you working on Indonesia translation
  3. Translate the object values in the file you have copied before
  4. Open browser and go to [APP_URL]lang/[language code].html
  5. Run npm run build after you finished

Add Audio Clip

Not all videos are suitable for clipping and the same should goes for audio. Please follow the derivative works guideline regarding audio clipping.

In addition there are some notes for audio source that need to be clipped.

  • Please don't clip from voice pack audio and cover or original song unless its from karaoke. Also, as in the derivative works guideline please don't clip from membership content, concert performance, or any paid content.
  • For singing clip it is recommended to clip only a song that has a reference to something such as meme, pop culture, etc. to prevent the song clips being too abundant. Also recommended to clip a song to show off Kobo singing skill.
  • Use standard or low preset to minimize the file size. You may use first_ehe.mp3 for reference.
  • Please be mindful about the clip duration to prevent bigger file size.

Steps for add audio clip.

  1. Clip the audio and you may need to process it with any audio editor
  2. Export it to mp3 file and put it in assets/aud/
  3. Add the audio data to assets/audio.json. Object properties description below
  4. Run/rerun npm run watch
  5. Open a browser and go to [APP_URL]lang/en.html
  6. Open playlist window by press and hold the Kobo button to test it out
  7. Run npm run build after you finished

Object properties for audio data

Property Required Description
name ✅ The file name of the audio. File name in snake_case.
title ✅ Title of the audio that will be displayed in main UI. Recommended to write it in their native language, use english if the audio data doesn't have lang property.
category ✅ Valid values are words, sound, and song.
lang ⏹️ Recommended to write it in their native language. Only required in words and song category.
isSeiso ✅ A flag to prevent the audio randomly played from Kobo button but still can be played from playlist. Not necessarily about seiso content.
next ❌ File name of the next chained audio that can be played by pressing the next button.