Skip to content

Commit ce3ccd4

Browse files
committed
chore: update readme.md
1 parent 0fe6659 commit ce3ccd4

2 files changed

Lines changed: 54 additions & 15 deletions

File tree

README.md

Lines changed: 53 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Whether you're a Japanese language learner using visual novels for immersion or
5959
- **Cross-platform**: Native support for Windows, with Linux compatibility
6060
- **VNDB Integration**: Automatic game information retrieval from VNDB
6161
- **Time Tracking**: Precise playtime monitoring with two tracking modes
62+
- **Jiten Integration**: Fetches Japanese character counts for visual novels, helping learners gauge reading difficulty and length.
6263
- **Discord Rich Presence**: Share your current reading activity
6364
- **Privacy-focused**: All data stored locally on your machine
6465

@@ -67,21 +68,31 @@ Whether you're a Japanese language learner using visual novels for immersion or
6768
## Features
6869

6970
### Core Features
70-
- **Visual Novel Library Management**: Add, edit, and organize your VN collection
71-
- **Automatic Playtime Tracking**: Monitor time spent reading each visual novel
72-
- **VNDB API Integration**: Search and import game information from VNDB database
73-
- **Game Launcher**: Launch games directly from the application
74-
- **Progress Tracking**: Keep track of your reading progress and completion status
71+
72+
- **Visual Novel Library Management**: Add, edit, and organize your VN collection, with support for manual additions and import from VNDB.
73+
- **Automatic Playtime Tracking**: Monitor time spent reading each visual novel.
74+
- **VNDB API Integration**: Search and import comprehensive game information from VNDB database.
75+
- **Game Launcher**: Launch games directly from the application.
76+
- **Progress Tracking**: Keep track of your reading progress and completion status.
77+
- **Flexible Filtering & Sorting**: Easily find games with advanced filtering and sorting options.
7578

7679
### Advanced Features
77-
- **NSFW Content Filtering**: Built-in blur filter for NSFW images (configurable)
78-
- **Pinned Games**: Quick access to your favorite or currently reading visual novels
79-
- **Character Information**: Optional character tracking and information display
80-
- **Discord Rich Presence**: Display current reading activity on Discord
81-
- **ExStatic Integration**: Enhanced playtime accuracy for Japanese learning
8280

81+
- **Category Management**: Create custom categories to organize your library and filter your games.
82+
- **Jiten Integration**: Fetches Japanese character counts for visual novels, helping learners gauge reading difficulty and length.
83+
- **In-App Update System**: Stay up-to-date with the latest features and bug fixes effortlessly.
84+
- **Customizable Theming**: Personalize your experience with multiple built-in themes and custom accent colors.
85+
- **NSFW Content Filtering**: Built-in blur filter for NSFW images (configurable).
86+
- **Pinned Games**: Quick access to your favorite or currently reading visual novels.
87+
- **Character & Notes Management**: Track character information and personal notes for each novel.
88+
- **Discord Rich Presence**: Display current reading activity on Discord.
89+
- **ExStatic Integration**: Enhanced playtime accuracy for Japanese learners.
90+
- **Random Game Selector**: Discover new or forgotten visual novels in your library.
91+
- **Statistics Reset**: Option to reset playtime and other statistics for a specific game.
92+
- **Customizable Playtime**: Choose how to display playtime information and opt to use Japanese titles for tracking.
8393

8494
### Platform Support
95+
8596
- **Windows**: Full native support with all features
8697
- **Linux**: Basic support (requires building from source)
8798
- **Cross-platform Data**: Portable configuration and database files
@@ -93,39 +104,46 @@ Whether you're a Japanese language learner using visual novels for immersion or
93104
### Prerequisites
94105

95106
For end users:
107+
96108
- Windows 10/11 (recommended) or Linux distribution
97109
- Internet connection for VNDB integration (works offline after downloading games info)
98110

99111
For developers:
112+
100113
- **Rust**: Install from [rustup.rs](https://rustup.rs/)
101114
- **Bun**: Install from [bun.sh](https://bun.sh/)
102115
- **Node.js**: Version 18+ (if not using Bun)
103116

104117
### Download & Install
105118

106119
#### Windows
120+
107121
1. Visit the [Releases page](https://github.com/Eroge-Abyss/tadoku/releases)
108122
2. Download the latest `.exe` installer
109123
3. Run the installer and follow the setup wizard
110124
4. Launch Tadoku from the Start menu or desktop shortcut
111125

112126
#### Linux
127+
113128
Currently, Linux users need to build from source. Pre-built binaries may be available in future releases.
114129

115130
### Building from Source
116131

117132
1. **Clone the repository**:
133+
118134
```bash
119135
git clone https://github.com/Eroge-Abyss/tadoku.git
120136
cd tadoku
121137
```
122138

123139
2. **Install dependencies**:
140+
124141
```bash
125142
bun install
126143
```
127144

128145
3. **Development build**:
146+
129147
```bash
130148
bun run tauri dev
131149
```
@@ -161,6 +179,7 @@ Tadoku offers two playtime tracking modes:
161179
- **ExStatic Integration**: Enhanced accuracy for Japanese learners
162180

163181
**To start tracking**:
182+
164183
1. Launch a game from your library
165184
2. Tadoku automatically detects when the game is running
166185
3. View accumulated playtime in the game details
@@ -208,16 +227,19 @@ For Japanese learners using text hooker tools:
208227
### Tech Stack
209228

210229
**Frontend**:
230+
211231
- SvelteKit 2.x
212232
- TypeScript
213233
- Vite
214234

215235
**Backend**:
236+
216237
- Rust with Tauri 2.x
217238
- VNDB API integration
218239
- Discord Rich Presence SDK
219240

220241
**Build Tools**:
242+
221243
- Bun (package manager)
222244
- Tauri CLI
223245
- Rust toolchain
@@ -241,16 +263,19 @@ tadoku/
241263
### Building
242264

243265
**Development**:
266+
244267
```bash
245268
bun run tauri dev
246269
```
247270

248271
**Production**:
272+
249273
```bash
250274
bun run tauri build
251275
```
252276

253277
**Linting and Formatting**:
278+
254279
```bash
255280
bun run format
256281
bun run check
@@ -263,19 +288,22 @@ bun run check
263288
We welcome contributions from the community! Here's how you can help:
264289

265290
### Getting Started
291+
266292
1. Fork the repository
267293
2. Create a feature branch: `git checkout -b feature-name`
268294
3. Make your changes and test thoroughly
269295
4. Submit a pull request with a detailed description
270296

271297
### Areas for Contribution
298+
272299
- Bug fixes and performance improvements
273300
- New features and enhancements
274301
- Documentation improvements
275302
- Translation and localization
276303
- Testing and QA
277304

278305
### Guidelines
306+
279307
- Follow the existing code style and conventions
280308
- Update documentation as needed
281309

@@ -286,22 +314,26 @@ We welcome contributions from the community! Here's how you can help:
286314
### Common Issues
287315

288316
**Game not launching**:
317+
289318
- Verify the executable path is correct
290319
- Check file permissions
291320
- Ensure the game is not already running
292321

293322
**Playtime not tracking**:
323+
294324
- Confirm classic mode tracking is enabled
295325
- Check if the game process is being detected
296326

297327
**VNDB search not working**:
328+
298329
- Check internet connection
299330
- Verify VNDB API is accessible
300331
- Try searching with different keywords
301332

302333
### Log Files
303334

304335
Logs are stored in:
336+
305337
- **Windows**: `C:\Users\{username}\AppData\Local\tauri\logs`
306338
- **Linux**: `/home/{username}/.local/share/tauri/logs`
307339

@@ -342,27 +374,32 @@ Remember to unset the environment variable if you no longer need debug mode (e.g
342374
## Screenshots
343375

344376
### Main Library View
377+
345378
![Main Library](assets/main_library.png)
346-
*Overview of your visual novel library with playtime tracking*
379+
_Overview of your visual novel library with playtime tracking_
347380

348381
### Game Details Page
382+
349383
![Game Details](assets/game_details.png)
350-
*Detailed information about individual games including characters and progress*
384+
_Detailed information about individual games including characters and progress_
351385

352386
### Add Game Modal
387+
353388
![Add Game](assets/add_game.png)
354-
*VNDB integration for easy game addition*
389+
_VNDB integration for easy game addition_
355390

356391
### Characters Page
392+
357393
![Characters](assets/characters.png)
358-
*Character information and tracking (optional feature)*
394+
_Character information and tracking (optional feature)_
359395

360396
---
361397

362398
## Acknowledgments
363399

364400
- **[Tauri](https://tauri.app/)**: For providing an excellent framework for building lightweight desktop applications
365401
- **[VNDB](https://vndb.org/)**: For maintaining the comprehensive Visual Novel database and API
402+
- **[jiten.moe](https://jiten.moe/)**: For providing the Jiten API for Japanese character count data.
366403
- **[SvelteKit](https://kit.svelte.dev/)**: For enabling fast and reactive frontend development
367404

368405
---
@@ -387,6 +424,7 @@ If you encounter issues or have questions:
387424
### Bug Reports
388425

389426
When reporting bugs, please include:
427+
390428
- Operating system and version
391429
- Tadoku version
392430
- Steps to reproduce the issue
@@ -396,6 +434,7 @@ When reporting bugs, please include:
396434
### Feature Requests
397435

398436
We welcome suggestions for new features! Please:
437+
399438
- Check existing feature requests first
400439
- Provide detailed use cases
401440
- Explain the expected benefit to users

src-tauri/Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)