groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2025-12-28 22:59:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding upload permission to users, directory structure readme update

Browse source
This commit is contained in:
Mark Cooper 2021-09-18 12:45:34 -05:00
parent 587adb3773
commit 8f1152762a
12 changed files with 148 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

59
readme.md
View file

@ -9,21 +9,56 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl
<img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" />
#### Folder Structures Supported:
### Directory Structure
```bash
/Title/...
/Author/Title/...
/Author/Series/Title/...
Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure.
Title can start with the publish year like so:
/1989 - Book Title/...
**Note**: Files in the root directory `/audiobooks` will be ignored, all audiobooks should be in a directory
(Optional Setting) Subtitle can be seperated to its own field:
/Book Title - With a Subtitle/...
/1989 - Book Title - With a Subtitle/...
will store "With a Subtitle" as the subtitle
```
**1 Folder:** `/Title/...`\
**2 Folders:** `/Author/Title/...`\
**3 Folders:** `/Author/Series/Title/...`
\
**Parsing publish year**
`/1984 - Hackers/...`\
Will save the publish year as `1984` and the title as `Hackers`
\
**Parsing volume number** (only if there is a series folder)
`/Book 3 - Hackers/...`\
Will save the volume number as `3` and the title as `Hackers`
`Book` `Volume` `Vol` `Vol.` are all supported case insensitive
These combinations will also work:\
`/Hackers - Vol. 3/...`\
`/1984 - Volume 3 - Hackers/...`\
`/1984 - Hackers Book 3/...`
\
**Parsing book subtitles** (optional in settings)
Title Folder: `/Hackers - Heroes of the Computer Revolution/...`
Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution`
\
**Full example**
`/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...`
Becomes:\
| Author | Steven Levy |
|---------------|-----------------------------------|
| Series | The Hacker Series |
| Publish Year | 1984 |
| Title | Hackers |
| Subtitle | Heroes of the Computer Revolution |
| Volume Number | 1 |
#### Features coming soon: