README-JA.md

PixiView

PixiView で快適な FANBOX ライフを！
PixiView は PIXIV FANBOX の非公式 Android クライアントアプリです

---

Status

Deprecated!! ⚠️

このリポジトリはまもなくアーカイブされます。 このリポジトリを元にKMP対応させた新しいリポジトリの方を今後はご利用ください。

Why?

FANBOX には Web 版しかなく、スマートフォンで投稿を閲覧するには少し不便だったからです。スマートフォン向けアプリとしてネイティブで開発することによって、投稿のダウンロード機能や新着通知などの便利な機能を複数搭載できました。

Tech Stack

• Kotlin
• Kotlin Coroutines
• Kotlin Flow
• Jetpack Compose
• Jetpack Glance
• Material3

Feature

Ready!!

• FANBOX
  • フォローしているクリエイターの投稿を時系列順に表示
  • 支援しているクリエイターの投稿を時系列順に表示
  • フォローしているクリエイターを表示
  • 支援しているクリエイターを表示
  • クリエイターのフォロー / フォロー解除
  • 投稿のいいね
  • クリエイター検索
  • タグ検索
  • プラン検索
  • 通知の表示
  • メッセージの表示
• ダウンロード
  • 画像 / ファイル / GIF 形式でダウンロード
  • 投稿に含まれるすべての画像をダウンロード
  • ファンカードのダウンロード
  • クリエイター単位での一括ダウンロード機能
• 広告
  • AdMob Native 広告

Not Ready...

• Pixiv 連携機能
• ウィジェット機能

Architecture

アプリのアーキテクチャ図を示します。 だいぶ複雑になっているので、一部のモジュールや依存関係は省略し、概略を掴める形にしています。

%%{
init: {
'theme': 'neutral'
}
}%%

graph LR
  subgraph gradle 
    build-logic  
  end  
  subgraph application
    app  
  end  
  subgraph core
    common
    datastore
    model
    repository
    ui
  end
  subgraph feature
    library
    creator
    post
  end
  app --> library
  app --> creator
  app --> post
  library --> ui
  library --> repository
  post --> ui
  post --> repository
  creator --> ui
  creator --> repository
  ui --> model
  repository --> datastore
  datastore --> model
  model --> common

Loading

Contribute

セットアップはとても簡単で、このリポジトリをクローン氏 bundle install するだけです。このアプリは daifuku と Puree を用いてログ基盤を作成しています。詳しくはライブラリのドキュメントまたは ./scripts/daifuku 以下をご覧ください。

このアプリは Gradle の Convention Plugins を用いてビルドのロジックを共通化しており、build-logic というモジュールに全てのロジックが記述されています。このアプローチに関しては、nowinandroid をご覧ください。

何か不具合を発見したり機能を改善したい場合、機能を新たに開発したい場合は、まず issue を書いてください。その上であなた自身を assign し、開発に取り組んでください。pull request はいつでも歓迎です 😄

このアプリは AdMob を用いて収益化しています。GitHub から手動でビルドする際は AdMob App ID を local.properties に記述する必要があります。デフォルトではダミーの ID が入っているため、起動時にクラッシュします。もしくは AdMob の当該コードを削除してからアプリをビルドしてください。その他、 local.properties には様々な ID が記述されています。詳細は app/build.gradle.kts または PixiViewConfig をご覧ください。

License

PixiView
Copyright (C) 2023 daichi-matsumoto

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also you can contact me by electronic mail at caios.system@gmail.com.

If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

    PixiView  Copyright (C) 2023 daichi-matsumoto
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs.  If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.  But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.