Commit 8712e336 authored by Guillaume Lebigot's avatar Guillaume Lebigot

NOUVELLE LICENSE ! + MAJ documentation + Renommage scripts Update

parent 9578100b
Pipeline #2701 passed with stages
in 8 minutes and 37 seconds
......@@ -23,10 +23,10 @@ You can either become a member of the database team or send your modifications v
Database team members have write access to this git repository as well as to the FTP server where videos are stored. If you'd like to become part of the team and get absolutely no advantages other than personal satisfaction for contributing to this, read the section below. If you're in the team already, read the following :
* [Download and install Karaoke Mugen](http://mugen.karaokes.moe)
* Create a folder called `app` and then another one called `data` in your KM install folder.
* Put your new videos in place in that folder
* Create a folder called `app` and then another one called `data` inside in your KM install folder.
* Put your new videos in place in that folder according to the usual structure, like `app/data/medias`
* Make any modification or add new karaoke songs by reusing an already existing `.kara` file as a template. Pick one from this database.
* If you're adding a new song, remove lines starting with `KID`, `date` and `video`
* If you're adding a new song, remove lines starting with `KID`, `date` and `media` save for `mediafile`
* Run Karaoke Mugen with the `--generate` option :
```sh
......@@ -40,8 +40,8 @@ yarn start --generate
```
* If generation returns no errors then you can go on. If it does, verify your `.kara` files.
* Send your video file to us, or if you have access to Shelter's FTP, upload your videos on Shelter or simply rename them if it only needs renaming.
* Commit & push once your videos are in place on Shelter, then submit your pull request.
* Send your media file to us, or if you have access to Shelter's FTP, upload your media files on Shelter or simply rename them if it only needs renaming.
* Commit & push once your media files are in place on Shelter, then submit your pull request.
## I want to help maintain the karaoke database
......@@ -62,7 +62,7 @@ And go to the #karaoke channel!
# French version
## Comment créer un karaoké ?
## Comment créer un karaoké ?
Nous avons écrit un document à ce sujet que vous trouverez ici :
......
# License
All karaokes are property of their respective authors.
Videos stored on Shelter are the property of their respective right holders.
We try, as much as possible, to fill the `author=` tag in a `.kara` file to credit the author of a karaoke. Some of them are empty simply because we are not aware of who created them. If you know, please submit a pull request.
You can use this database as you wish as long as it is credited somewhere.
The database in itself uses a MIT license.
```
MIT License
Copyright (c) [year] [fullname]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The files in this repository are under a [Creative Commons 4.0 BY-NC-SA license](http://creativecommons.org/licenses/by-nc-sa/4.0/)
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
If you have questions about the license or wish to ask for a specific permission, feel free to [contact us](http://mugen.karaokes.moe/en/contact.html) or [open an issue](https://lab.shelter.moe/karaokemugen/karaokebase/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=)
\ No newline at end of file
......@@ -4,7 +4,7 @@
## Karaoke Mugen database
This is the git repository for the [Karaoke Mugen](http://mugen.karaokes.moe) karaoke database. It is to be used with the software found at the site linked just now, but you can also use it freely for your own purposes.
This is the git repository for the [Karaoke Mugen](http://mugen.karaokes.moe/en) karaoke database. It is to be used with the software found at the site linked just now, but you can also use it freely for your own purposes. See [our license](LICENSE.md) for more information.
## Format
......@@ -12,7 +12,7 @@ A karaoke is made of the following elements :
* A `.kara` file in the `karas` folder
* A `.ass` file in the `lyrics` folder
* A video file in the `videos` folder
* A video or audio file in the `medias` folder
### `karas` folder
......@@ -20,7 +20,7 @@ This folder holds files with karaoke metadata such as video file, lyrics file, e
Example :
```
videofile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
subfile=ANG - Porter Robinson & Madeon - MV - Shelter.ass
year=2016
singer=Amy Millan
......@@ -31,14 +31,15 @@ author=karaokes.moe
series=Shelter
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
videosize=109238678
videoduration=367
videogain=-5.49
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
dateadded=1507741308
title=Shelter
type=MV
order=
version=1
version=3
```
Some parameters are mandatory while others are generated by the Karaoke Mugen software when launching it with the `--validate` or `--generate` options.
......@@ -51,15 +52,15 @@ This folder contains the subtitles files as specified in the `.kara` file.
It is generally a `.ass` file made with AegisSub. See [the contribution guide](CONTRIBUTING.md) for a more detailed tutorial on how to write good karaokes.
### `videos` folder
### `medias` folder
This folder contains the video file as specified in the `.kara` file.
This folder contains the video or audio file as specified in the `.kara` file.
Videos aren't included in this git repository or else it'd be way too huge (about 170Gb at the moment). You can launch `UpdateVideos.cmd` on Windows or `UpdateVideos.sh` on macOS/Linux to get the latest version of the videos folder via rsync from the Shelter server.
Videos aren't included in this git repository or else it'd be way too huge (about 190Gb at the moment). You can launch `UpdateMedias.cmd` on Windows or `UpdateMedias.sh` on macOS/Linux to get the latest version of the `medias` folder via rsync from the Shelter server.
Launch the update script each time you pull/clone/download a new version of this repository to make sure the videos folder is in sync with the `.kara` files you just downloaded.
Launch the update script each time you pull/clone/download a new version of this repository to make sure the `medias` folder is in sync with the `.kara` files you just downloaded.
If you get errors from Karaoke Mugen during database generation / folder validation, make sure you have the latest version of the repository (`git pull` or downloaded latest `master.zip`) and that you ran the `UpdateVideos` script at least twice in a row.
**If you get errors from Karaoke Mugen during database generation / folder validation, make sure you have the latest version of the repository (`git pull` or downloaded latest `master.zip`) and that you ran the `UpdateMedias` script at least twice in a row.**
## I want to contribute and make some karaoke or send ones I already own
......@@ -83,7 +84,7 @@ Un karaoké Karaoke Mugen est composé de 3 éléments rangés dans des dossiers
* Un fichier `.kara` dans le dossier `karas`
* Un fichier `.ass` dans le dossier `lyrics`
* Un fichier vidéo dans le dossier `videos`
* Un fichier vidéo ou audio dans le dossier `medias`
### Dossier `karas`
......@@ -91,7 +92,7 @@ Ce dossier regroupe les fichiers qui contiennent les informations permettant d'a
Exemple :
```
videofile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
subfile=ANG - Porter Robinson & Madeon - MV - Shelter.ass
year=2016
singer=Amy Millan
......@@ -102,14 +103,15 @@ author=karaokes.moe
series=Shelter
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
videosize=109238678
videoduration=367
videogain=-5.49
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
dateadded=1507741308
title=Shelter
type=MV
order=
version=1
version=3
```
Certains éléments sont obligatoires, d'autres sont générés par le logiciel Karaoke Mugen lors de la validation des fichiers .kara
......@@ -122,11 +124,11 @@ Contient le fichier de sous-titres tel que spécifié dans le .kara
Il s'agit d'un .ass généralement crée via AegisSub. Voyez [le guide de contribution](CONTRIBUTING.md) pour des tutoriels sur comment faire de bons karaokés dans ce format.
### Dossier `videos`
### Dossier `medias`
Contient le fichier de vidéo tel que spécifié dans le .kara
Contient le fichier de vidéo ou d'audio tel que spécifié dans le .kara
Les vidéos ne sont pas fournies dans ce dépôt, par souci de place (et ça ferait un dépôt de 170 Go au bas mot). Vous pouvez néanmoins lancer `Mettre a jour videos.cmd` (Windows) ou `UpdateVideos.sh` (OSX/Linux) pour récupérer les vidéos par rsync depuis le serveur Shelter.
Les vidéos ne sont pas fournies dans ce dépôt, par souci de place (et ça ferait un dépôt de 170 Go au bas mot). Vous pouvez néanmoins lancer `UpdateMedias.cmd` (Windows) ou `UpdateMedias.sh` (OSX/Linux) pour récupérer les vidéos par rsync depuis le serveur Shelter.
Pensez à lancer régulièrement ce script, parfois deux fois de suite pour vous assurer que tout a bien été récupéré. Le dossier de vidéos colle à la dernière version de la base.
......@@ -136,6 +138,6 @@ Si vous rencontrez des erreurs de Karaoke Mugen durant la génération de la bas
Lisez [le guide de contribution](CONTRIBUTING.md) pour savoir comment faire et trouver de l'aide.
## Puis-je utiliser tout ça gratuitement?
## Puis-je utiliser tout ça gratuitement ?
Voir [la license d'utilisation](LICENSE.md)
......@@ -2,4 +2,18 @@
These are scripts used for base maintenance and other utilities.
There are also a [bunch of code snippets](https://lab.shelter.moe/karaokemugen/karaokebase/snippets) you might want to take a look at.
\ No newline at end of file
There are also a [bunch of code snippets](https://lab.shelter.moe/karaokemugen/karaokebase/snippets) you might want to take a look at.
## delay.sh
Adds a 1 second delay at the beginning of a line in ASS files. This allows them to appear a bit before the line is to be sung.
This modification is usually applied by timers individually using AegisSub during karaoke timing, but this Bash script allows to run this on many .ass at once.
## export_json.sh
Exports a SQLite Karaoke Mugen database into JSON.
## stats.sh
Exports basic stats from a SQLite Karaoke Mugen database into JSON.
\ No newline at end of file
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