Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Daniel-C-J/vndb-lite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

64 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Warning

  1. This app may contain explicit content, so viewer discretion is strongly advised.
  2. This app is in dormant mode, and there are some known issues specifically about the local collection. Hopefully will be maintained again in somewhere in 2025 ~ early 2026 :).

[VNDB Lite]

A lite open-source mobile version of your favorite vndb.org website.



Table of Contents
  1. Quick Start
  2. Disclaimer
  3. About The Project
  4. Getting Started
  5. Usage
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

Quick Start

Currently, this app only supports for Android. I am unable to test the app for IOS platform, since I don't have any apple device. Contact me if you want to help me testing for IOS platform! :D

Download latest version here.

(back to top)

Disclaimer

This project, VNDB Lite, is not an official app advertised by the official website itself. It is simply just a personal project that the developer himself found interesting, and worthwhile expanding his skills and knowledge in mobile development.

(back to top)

About The Project

Community and support

This is a very new project with a lot of potential to improve. If you'd like to help out, please give it a star 🌟 and share it with the others! You can also jump in and start contributing right away! Just fork the project and suggest any changes you'd like me to consider. That'll be very helpful for a small developer like me.

And hey, I'm always open for donation!

ko-fi

(back to top)

About VNDB

It is a website that houses a large public database of Visual Novels, hence the name stands for Visual Novel DataBase (VNDB). You can learn more about the website itself here.

(back to top)

About VNDB Lite

Do read the disclaimer above first please.

This app is still in development, and is heavily inspired by Tachiyomi (A digital comic reading app), someone from reddit which I forgot, and a picture I found from the internet which looks really cool! That picture gave me a lot of inspiration. I tried to make one like that, but I ended up having a lite version and a sleep apnea instead.

If you ever use Tachiyomi or similar app, then I assure you can adapt fast with this app's UI.

VNDB Lite is currently released for Android only, and it only supports Android 5.0+.

Unfortunately and currently, I don't have any IOS device to neither build nor even test the app. But as the framework (Flutter) itself supports cross-platform, you can build yourself the app from the source code for your own specific platform, and then test it.

(back to top)

Main Features

As the name stated: Lite, this app does not cover the entire feature you might found in the original website itself, though, some of the fundamentals are covered in this app.

Here are the features:

  1. Up to 11 VNDB official themes (though some of them sucks, I really am following the official theme, so don't blame me lol)

  2. Previews of VNs (Based on latest user collection, and Top-bys)
    Previews

  3. Advanced search
    Previews

  4. Easy to save vn selection and multiselection

  5. VNDB latest statistics chart (I know it's ugly, but at least it can spin)

  6. Local collection

  7. VNDB account synchronization

  8. Offline mode (Once entering vn detail screen)

  9. Double-click to censor/uncensor cover πŸ‘€

  10. (งツ)ΰΈ§ And many more...!

Warning

VNDB Lite Synchronization does not support the following:

  1. Custom status other than the built-in ones, such as: playing, finished, stalled, dropped, wishlist, and blacklist. Other than that will be considered invalid and will not be synchronized.
  2. A VN item which has multiple status on it, such as: playing, and dropped in a single item, that is not fully valid. Synchronization with VNDB Lite will only take one from the two. But any of the built-in status with voted is valid.
  3. Saving the changes made from the cloud to the local once successfully synchronized. VNDB Lite's synchronization is local-oriented, so once user synchronized, any change from the cloud, such as editing an already existing item, will not be tolerated, and will be overrided instead by the local existing ones instead the moment user synchronizing again. The same thing happens when deleting an item from the cloud, once synchronizing again, if the item still exists in local, then it will go back to the cloud (in a form of a backup). The only thing that local tolerated with cloud changes, is that adding a new item from the cloud, and that will be saved in the local.
  4. The ability to immediately synchronize lot of vns (probably 60+) at once in a single synchronization. There are times when your cloud vns are not fully synchronized in the local collection after the first time synchronization, especially if you've lots of vns in your vndb collection. Make sure that after a short delay, try to synchronize again until it fully indexing all of your cloud vns in the local collection.

Consider changing your collection via vndb.org first to make sure that all of your VNs are valid when synchronizing using this app.


TODOS:

  • Landscape mode optimization
  • Custom background
  • Detail screen UI update
  • Filter & Sort mechanism
  • Better collection methods
  • Vn review
  • Vn self-note (Add note to a certain vn)
  • New vn releases news

Dev note:

  • No, there will be no localizations. – =͟͟͞͞ =͟͟͞͞ ヘ( Β΄Π”`)οΎ‰ I can engrish

(back to top)

Built With

With main dependencies such as:

And many more...!

See Changelog

(back to top)

History

Migrated to an upcoming blog site πŸš›...

Getting Started

Prerequisites

To avoid incompatibility, it is recommended that at least you have flutter's engine with version of 3.29.2 (stable). Here's how to check yours.

flutter --version

Also do check whether there's anything wrong with the engine.

flutter doctor -v

Installation

  1. Clone this repository
git clone https://github.com/Daniel-C-J/vndb-lite.git
  1. Open your terminal and cd to the root path of the repository, for example:
cd vndb-lite
  1. Type flutter build --help then head down to the Available subcommands: section, you'll be able to found the platform specific options to build the app.
flutter build --help 
flutter build apk --release # If you choose to build android app.
  1. The output path is usually in ./build, for android specifically it is in ./build/app/outputs/flutter-apk/ alongside with the sha-1 hash.
start . # To quickly opens file explorer to see for yourself the output.
  1. And you're done! Congrats πŸŽ‰!

(back to top)

Usage

Well there's no real official documentation yet for this project, and it is as simple as managing your own library. So have fun, and experiment with it!

screenshot screenshot screenshot screenshot screenshot screenshot screenshot screenshot screenshot screenshot

(back to top)

License

Distributed under the Apache-2.0 License.

(back to top)

Contact

Daniel CJ - dcj.dandy800@passinbox.com

Project Link: https://github.com/Daniel-C-J/vndb-lite

(back to top)

Acknowledgments

  • Synchronized data is stored in vndb.org via its official API.
  • The icon used for this app is not mine, it's one of majikoi's CG, and I'm just using it just for fun.

(back to top)