{"id":18286550,"url":"https://github.com/mntone/vookit","last_synced_at":"2026-04-30T10:03:20.768Z","repository":{"id":177866235,"uuid":"655267893","full_name":"mntone/VookIt","owner":"mntone","description":"VookIt is short video sharing software. IN THE DEVELOPMENT STAGES.","archived":false,"fork":false,"pushed_at":"2023-12-28T22:08:09.000Z","size":1144,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-15T00:46:03.689Z","etag":null,"topics":["120fps","audio","bullmq","clips","media","prisma","react","reactions","share","sns","social-media","tags","video"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mntone.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-18T11:55:48.000Z","updated_at":"2023-07-18T09:31:49.000Z","dependencies_parsed_at":"2023-11-07T05:31:14.235Z","dependency_job_id":null,"html_url":"https://github.com/mntone/VookIt","commit_stats":null,"previous_names":["mntone/vookit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntone%2FVookIt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntone%2FVookIt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntone%2FVookIt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntone%2FVookIt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mntone","download_url":"https://codeload.github.com/mntone/VookIt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247989275,"owners_count":21029272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["120fps","audio","bullmq","clips","media","prisma","react","reactions","share","sns","social-media","tags","video"],"created_at":"2024-11-05T13:20:58.518Z","updated_at":"2026-04-30T10:03:15.715Z","avatar_url":"https://github.com/mntone.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VookIt!\n\n✨100%趣味で書かれたソフトウェアです。\n\nI really wanted to write a sentence in Japanese. It means “This software is written entirely as a hobby.” It’s sales copy of light-weighted novel, *BAKEMONOGATARI*.\n\n  VookIt! = \u003cu\u003eV\u003c/u\u003eideo + B\u003cu\u003eook\u003c/u\u003emark \u003cu\u003eit!\u003c/u\u003e\n\n*VookIt* is short video sharing software. **In the Development Stages!!**\n\n~~日本語で「ヴキット！」って発音してほしいけど、字面にするとダサい、草。~~\n\n## Features and Future\n\n### Implemented features\n\n- Create MPEG-DASH \u0026 HLS files automatically\n- Ultrawide (21.6:9) \u0026 120 fps video support\n- Chunk uploading with JavaScript\n- HEVC (default off) \u0026 AV1 video support\n\n### TODO\n\n- **Manage streams** (I'm sorry. Currently, stream name isn't applied automatically.)\n- **User authentication**\n- Tag\n  - Tune encode settings by game title tag.\n- Bypass audio data (ABR 256 kbps AAC-LC only)\n- Detect device features (120 fps, HDR and supported codec)\n\n### Planned Features\n\n- Markdown Description\n- Limited Share (account-based \u0026 time-based limit)\n- List view for top page\n- Reaction (like misskey.io)\n  - Text-based (use emoji and short word)\n    - like \"lol\", \"No Way!\", \"For Real?\", \"What?\", \"(笑)\", \"笑\", \"草\", \"w\", \"W\", \"www\", \"草www\", \"草に草生やすなwww\", \"マジで?\" and \"🤔\"\n    - DO NOT TRANSLATION. But, show meaning.\n- Portrait video support\n- HDR video support\n  - 10-bit encoding system\n  - SDR color grading\n\n### Under Consideration\n\n- Change database\n\n### Not Planned Features\n\n- **Live streaming**\n\n## How to Use\n\n1. Install nodejs, ffmpeg and SQLite.\n2. Build static assets.\n  ```shell-session\n  % npm run webpack:build\n  ```\n3. Generate SSL certificate (if use ssl) and session key.\n  ```shell-session\n  % npm run openssl:init\n  % npm run session:init\n  ```\n4. Set docker volume up.\n  ```shell-session\n  % docker volume create vhosting_node_modules\n  ```\n5. Start docker and hawks (backend). Currently, use local node.js and ffmpeg for the backend.\n  ```shell-session\n  % docker-compose up -d\n  % npm run hawks:start\n  ```\n6. (Tentatively) Create your user. Currently program use screenname \"dev\" (hard coding on source).\n  ```shell-session\n  % npm run user:new dev [password]\n  ```\n7. (Manual) Rename directory after encoding. For example, rename \"./.media/[usid]/st_avc1_ntvp\" to \"./.media/[usid]/avc1\". In the future, program use as-is stream name like \"st_avc1_720p\" or \"st_avc1_ntvp\".\n\n## Architecture\n\n### Frontend: clogs\n\n- Controllers: parse requests, invoke usecases and return objects ([nest](https://nestjs.com/) with [fastify](https://fastify.dev/))\n- Views: build views ([React](https://react.dev/) SSR + [Bulma](https://bulma.io/))\n- Usecase: execute jobs\n- Database: read/write data ([Prisma](https://www.prisma.io/) with sqlite)\n\n```\n+-------------+\n|   Browser   |\n+-------------+\n  ↓ 1  ↑ 6\n+-------------+\n| Controllers |\n+-------------+\n  ↓ 2  ↑ 5\n+-------------+\n|   Usecase   |\n+-------------+\n  ↓ 3  ↑ 4\n+-------------+\n|  Database   |\n+-------------+\n```\n\n### Backend: hawks\n\n- Service Workers: dispatch tasks ([BullMQ](https://docs.bullmq.io/) with [Redis](https://redis.io/))\n- Dispatchers: create jobs (internal)\n- Encoders: encode video and audio (ffmpeg with x264, x265, libvpx, SVT-AV1 and so on…)\n\n```\n+-----------------+\n| Service Worker  |\n+-----------------+\n    ↓ 1    ↑ 4\n+-----------------+\n|   Dispatcher    |\n+-----------------+\n    ↓ 2    ↑ 3\n+-----------------+\n|     Encoder     |\n+-----------------+\n```\n\n## Authors\n\n- mntone - Initial work.\n\n## License\n\n*VookIt!* is licensed under the GPLv3 license - see the [LICENSE.txt](https://github.com/mntone/VookIt/blob/master/LICENSE.txt) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmntone%2Fvookit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmntone%2Fvookit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmntone%2Fvookit/lists"}