GitHub - pbuyle/Chocolate: The future of media manager

About The Project

Chocolate is an Open Source media manager.
It allows you to manage your media collection and organize it in a way that is easy to use and easy to search.
Pair your popcorn with Chocolate and enjoy your favorite movie!
It's a free software.

This product uses the TMDB API but is not endorsed or certified by TMDB |

Built With

Chocolate is actually made with this technologies:

Getting Started

This is what you have to do to get started with Chocolate :

Prerequisites

Installation

For Linux

Go to the latest release
Download the latest installer named install.sh
Place it where you want
Run it
Enjoy !

For Windows

No installer available actually
So download the source code and install the dependencies (requirements.txt, ffmpeg and winrar (only for cbr files so books))
For ffmpeg and winrar, you have to add them to your PATH

For QNAP

Go here: https://www.myqnap.org/product/chocolate81/
Enjoy !

For Docker

Execute docker pull imprevisible/chocolate
Enjoy !

Files organizations

For Movies :

Create a directory
Put all your movies in with a proper name, like "Batman Begins.mkv" instead of "Batman.Begins.H264.AAC.XxMOVIESxX.mkv", they can be in subdirectories (only one level, one movie per directory)

📂 Movies
 ├── 📂 Batman Begins      # Perfect
 │    └── Batman Begins.mkv
 ├── Back to the Future.mkv
 ├── Harry Potter and the Philosopher's Stone.mkv
 │
 ├── 📂 The Lord of the Rings    # Don't do that please (two movies in one directory !)
 │    ├── The Lord of the Rings - The Fellowship of the Ring.mkv
 │    └── The Lord of the Rings - The Two Towers.mkv

Create a new library and select the directory you created with the specific type
It's done

For Shows :

Create a directory
Create a directory for each shows
In this directory create directory for each seasons, if possible named them like that : "S1", "S2", "S26"
In this seasons directory put all épisodes files, and if possible named them like that : "E1.mkv", "E2.mp4", "E56.avi"
Precisions : Chocolate will ask you to rename files and directory if it don't understand, you can agree or disagree is proposition

📂 Shows
 ├── 📂 The Office           # Perfect
 │    ├── 📂 S1
 │    │    ├── E1.mkv
 │    │    ├── E2.mkv
 │    │    └── E3.mkv
 │    │
 │    └── 📂 S2
 │         └── E1.mkv
 │
 ├── 📂 The Simpsons        # Don't do that please
 │    └── 📂 Season 1
 │         ├── The.Simpsons.EP.One.mkv
 │         ├── The.Simpsons.EP.Two.mkv
 │         └── The.Simpsons.EP.Three.mkv

Create a new library and select the directory you created with the specific type
It's done

For Games :

Create a directory
Create a directory for each consoles
For each directory put games for this console
Some consoles need a bios, go to /static/bios/
- Create a directory named by the console
- Put in the bios file
It's done

For Books :

Create a directory
Put all your books in with the name that you want
It's done

List of supported console :

Gameboy
Gameboy Color
Gameboy Advance
Nintendo DS
Nintendo 64
Nintendo Entertainment System
Super Nintendo Entertainment System
Sega Master System
Sega Mega Drive
Sega Saturn
Sony Playstation 1 (for .cue and .bin you have to .zip all files) (need a bios)

Start Chocolate

For Linux

execute 'chocolate' in your terminal

For Windows

Execute app.py

For Docker

Execute :
- CMD : docker run -d -v %cd%:/chocolate imprevisible/chocolate
- Powershell : docker run -d -v ${PWD}:/chocolate imprevisible/chocolate
- Linux : docker run -d -v $(pwd):/chocolate imprevisible/chocolate

Important Informations

At the first launch, Chocolate will be very fast if you don't renseign the path in config.ini.
If you don't change all the paths. Go to the settings, and fill in the forms.
You can change a lot of settings directly on the website.
The default port is 8500.

Usage

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

TO-DO for Chocolate Server

Work in progress

Detect series intro and skip them
Dev a mobile/TV app with chromecasting, and download
Use Flask-PWA
Add all audio tracks
Translate the rescan buttons
Add website UI to link with Radarr, Sonarr, Lidarr... (with pyarr/aiopyarr)
Move the UI to React

Tasks Done

Languages to translate

Contact

Official Discord Server - https://discord.gg/qbWdzuPhZ4
Project Link: https://github.com/ChocolateApp/Chocolate
Impre'visible#2576 - @romeo_chevrier - [email protected]

Acknowledgments

If you like this project, please consider giving me a star ⭐ to support my work and the futures update of this project.

This tool was made by Impre-visible, some features needed the help of several volunteers, that I thank, you can contact them on this server : Dev'Area

Original website design from Mart on figma
A special thanks to Mathias08 who made it possible to release v1 of Chocolate and MONSTA CARDO !! who made the animated logo !

The consoles images are in part from Jude Coram the rest are made by me.

This tool was made with ❤ and ☕ by Impre-visible.

License

This work is licensed under a

Name		Name	Last commit message	Last commit date
Latest commit History 186 Commits
static		static
templates		templates
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
app.py		app.py
config.ini		config.ini
convert.py		convert.py
docker-compose.yml		docker-compose.yml
intro.py		intro.py
licence.md		licence.md
requirements.txt		requirements.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation