Commit 1c1f4fd3 authored by Guillaume Lebigot's avatar Guillaume Lebigot
Browse files

chore: updating markdown files [skip-ci]

parent e0ba2ca2
......@@ -37,7 +37,7 @@ Please respect coding conventions already in place as much as possible.
If an issue needs to be fixed, a milestone will be added to it by a maintainer. At this point anyone can take the issue and work on it.
If a issue is closed but has not been fixed and could be reopened, please add a comment to it and wait for a maintainer to reopen it.
If an issue is closed but has not been fixed and could be reopened, please add a comment to it and wait for a maintainer to reopen it.
### Working on an issue
......
......@@ -5,27 +5,30 @@
![presentation](img/presentation.png)
Master branch: [![pipeline status](https://lab.shelter.moe/karaokemugen/karaokemugen-app/badges/master/pipeline.svg)](https://lab.shelter.moe/karaokemugen/karaokemugen-app/commits/master) -
Next branch: [![pipeline status](https://lab.shelter.moe/karaokemugen/karaokemugen-app/badges/next/pipeline.svg)](https://lab.shelter.moe/karaokemugen/karaokemugen-app/commits/next)
Next branch: [![pipeline status](https://lab.shelter.moe/karaokemugen/karaokemugen-app/badges/next/pipeline.svg)](https://lab.shelter.moe/karaokemugen/karaokemugen-app/commits/next) [![Requirements Status](https://requires.io/github/AxelTerizaki/karaokemugen-app/requirements.svg?branch=master)](https://requires.io/github/AxelTerizaki/karaokemugen-app/requirements/?branch=master)
![Last commit](https://img.shields.io/github/last-commit/AxelTerizaki/karaokemugen-app.svg) ![Latest version](https://img.shields.io/github/tag/karaoke-mugen/karaokemugen-app.svg) ![License](https://img.shields.io/github/license/karaoke-mugen/karaokemugen-app.svg) ![Size](https://img.shields.io/github/repo-size/karaoke-mugen/karaokemugen-app.svg) ![Discord](https://img.shields.io/discord/84245347336982528.svg)
[Visit Karaoke Mugen's homepage](http://karaokes.moe)
Project: ![Last commit](https://img.shields.io/github/last-commit/AxelTerizaki/karaokemugen-app.svg) ![Latest version](https://img.shields.io/github/tag/karaoke-mugen/karaokemugen-app.svg) ![License](https://img.shields.io/github/license/karaoke-mugen/karaokemugen-app.svg) ![Size](https://img.shields.io/github/repo-size/karaoke-mugen/karaokemugen-app.svg) ![Commits since release on next](https://img.shields.io/github/commits-since/axelterizaki/karaokemugen-app/release/next)
Social: [![Discord](https://img.shields.io/discord/84245347336982528.svg)](http://karaokes.moe/discord) Twitter [![Social](/twitter/follow/:user?label=Follow)](https://twitter.com/KaraokeMugen)
Karaoke Mugen is a playlist manager and player for video and audio karaoke. It's made of a webapp and an engine. The webapp allows users to search for and add songs and admins to manage the karaoke session and playlists. The engine plays those songs on the computer used to display the video.
It works like a japanese karaoke where anyone can add songs one after another to a playlist with their smartphone, tablet or computer. The playlist can be reviewed by an admin or played "as is". This behaviour is configurable.
It works like a japanese karaoke where anyone can add songs one after another to a playlist with their smartphone, tablet or computer. The playlist can be reviewed by an operator or played "as is". This behaviour is configurable.
Karaoke Mugen works offline and does not require an Internet connection, but a few of its features may need online access.
Karaoke Mugen can work offline and can do without an Internet connection, but a few of its features need online access.
This is a mature product, battle-tested during anime conventions like [Jonetsu](http://www.jonetsu.fr), Japan Expo or Japanantes and similar events, weddings, anime nights between friends, etc. There still are some bugs remaining we'd like to exterminate, obviously :).
[Visit Karaoke Mugen's homepage](http://karaokes.moe)
## Features
* **Accepted formats**:
* **Video**: AVI, MP4, MKV (anything supported by [mpv](http://mpv.io) really)
* **Subtitles**: ASS, Karafun, KAR, Epitanime Toyunda, Ultrastar .txt files (if not ASS, they will be converted to ASS upon importation, and cannot be used directly)
* **Music**: MP3, M4A, OGG
* **Complete player controls**: Skip, pause, play, stop, rewind playback, hide/show lyrics, mute/unmute and volume control
* **Music**: MP3, M4A, OGG (anything supported by [mpv](http://mpv.io) really)
* **Complete player controls**: Skip, pause, play, stop, rewind playback, hide/show lyrics, mute/unmute and volume control.
* **Playlist management**: Reorder, shuffle, copy and move songs around between playlists
* Playlists can be _current_ (used by the video player) and/or _public_ (where users can send songs to)
* Playlists can be _hidden_ from public interface.
......@@ -35,24 +38,27 @@ This is a mature product, battle-tested during anime conventions like [Jonetsu](
* Complete **filter system** and **search engine** based on the aforementionned metadata.
* **System Panel** to configure Karaoke Mugen:
* **Multi-karaoke repositories support**: You can add as many repositories you want. Karaoke Mugen has 2 "official repositories": the [otaku base](https://lab.shelter.moe/karaokemugen/bases/karaokebase) and the [world base](https://lab.shelter.moe/karaokemugen/bases/karaokebase-world)
* **Configure** application behaviour
* **User profiles** with access rights, favorites list, and other info
* **Configure** application behaviour and **view logs**
* **Manage** your song library (add, remove, edit...)
* **View stats** like most played or requested songs
* **User profiles** with access rights, favorites list, and other info
* **Web interface** for smartphone/tablet/PC ~~IE6 compatible~~
* This interface is for public and can be set to _restricted mode_ to prevent adding songs or in _closed mode_ to prevent access.
* Public interface is for public and can be set to _restricted mode_ to prevent adding songs or in _closed mode_ to prevent access while you prepare your karaoke.
* Users can **add the songs** they want from the library.
* Admins can **organize playlists** and control the player.
* Operators can **organize playlists** and control the player through the operator interface.
* **Highly customized experience** to tailor the app to your specific needs (in front of a crowd, between friends, for karaoke contests, etc.)
* **Displays karaoke information** or admin announcements during song playback
* **Export/import** playlists and favorites
* **Display karaoke information** or operator announcements during song playback
* **Export/import** playlists, favorites, blacklist criterias sets
* **[REST API](http://mugen.karaokes.moe/apidoc)** so you can create custom clients or web interfaces.
* And **many other things**! Check out the [feature list](http://mugen.karaokes.moe/en/features.html)
## How it works
* See the **[install](#install)** section below
* **Launch the app** (see the launch section below). You will be prompted with some questions and you will create an account.
* **Launch the app** (see the launch section below). You will be prompted with some questions and you will need to create an account (online or local).
* Use the **in-app downloader** or place karaoke songs inside the `app/repos` folder. See the [karaoke base repository](https://lab.shelter.moe/karaokemugen/karaokebase) and [documentation](http://docs.karaokes.moe/en/user-guide/manage/). If you don't want to add a full karaoke base for now, Karaoke Mugen will download samples from karaoke repositories in your `app/repos` folder if it's left empty so you can try out the app.
* Once your playlist is ready, invite some friends and direct them to the public interface with their device. Let them add songs. Once enough songs are added, hit play and **have fun**!
* **Your users need to be on the same Wifi/LAN network you are on for this to work.**
In the repository mentioned above, you'll find a karaoke songs database ready for use. Beware, it's over a few hundreds gigabytes big once the videos have been downloaded.
......@@ -62,9 +68,9 @@ For more information, check out the [documentation site](http://docs.karaokes.mo
The app is multi-platform and works on Linux/Windows/macOS.
It requires nodeJS 12 or above.
For source installs, it requires nodeJS 12 or above, as well as postgresql, mpv and ffmpeg binaries (see below).
It also requires postgresql, mpv and ffmpeg binaries (see below).
For binary installs, everything's included.
## Install
......@@ -84,7 +90,7 @@ Portable mode is useful if you're storing Karaoke Mugen on a removeable media or
### Required binaries
mpv (video player), ffmpeg (video processing) and postgreSQL (database) are required by Karaoke Mugen.
mpv (video player), ffmpeg (video/audio processing) and postgreSQL (database) are required by Karaoke Mugen.
#### Depending on your system
......@@ -114,12 +120,12 @@ ffmpeg 3 or later is required ([ffmpeg's website](http://www.ffmpeg.org))
PostgreSQL 10.6 or later is required ([postgreSQL's website](https://www.postgresql.org/))
Earlier PostgreSQL versions (9.x, 10.x...) should work but have not been tested.
Earlier or later PostgreSQL versions (9.x, 10.x, 12.x...) should work but have not been tested.
Karaoke Mugen can use PostgreSQL in two ways :
* **Existing database cluster :** Connect to an existing PostgreSQL server (edit the `database.json` file to point to the correct server and database)
* **Bundlded PostgreSQL version :** If `bundledPostgresBinary` is set to `true` in `database.json` then Karaoke Mugen will seek a `app/bin/postgresql` directory. Inside, you should have a complete PostgreSQL distribution including a `bin`, `lib` and `share` folders. Karaoke Mugen needs to find the `pg_ctl` binary in the `bin` folder.
* **Existing database cluster :** Connect to an existing PostgreSQL server (edit the `app/database.json` file to point to the correct server and database)
* **Bundlded PostgreSQL version :** If `bundledPostgresBinary` is set to `true` in `app/database.json` then Karaoke Mugen will seek a `app/bin/postgresql` directory. Inside, you should have a complete PostgreSQL distribution including a `bin`, `lib` and `share` folders. Karaoke Mugen needs to find the `pg_ctl` binary in the `bin` folder.
### Yarn
......@@ -233,7 +239,7 @@ Everything's there, and if you have questions, you can come to [our Discord](htt
## Special thanks
<img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry full logo" width="125"/>
Thanks to [Sentry error tracking](https://sentry.io/welcome?utm_source=KaraokeMugen) solution, the app is self-reporting its errors to maintainers to help them to fix issues.
Thanks to the [Sentry error tracking](https://sentry.io/welcome?utm_source=KaraokeMugen) solution, the app is self-reporting its errors to maintainers to help them to fix issues.
## Credits
......@@ -241,4 +247,4 @@ Thanks to [Sentry error tracking](https://sentry.io/welcome?utm_source=KaraokeMu
## License
Karaoke Mugen is licensed under MIT License. Other projects related to Karaoke Mugen may have other license terms. Please check every project for more informations.
Karaoke Mugen is licensed under MIT License. Other projects related to Karaoke Mugen may have other license terms. Please check every project for more information.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment