Skip to content
This repository has been archived by the owner on Nov 13, 2017. It is now read-only.

Latest commit

 

History

History
130 lines (93 loc) · 7.11 KB

README.md

File metadata and controls

130 lines (93 loc) · 7.11 KB
Raw

IMPORTANT
Repository Archived: we continue here now: https://framagit.org/peppercarrot
We moved on November 2017 to this new platform. Details here. The current repository will be removed in 2018

Pepper & Carrot

alt tag

GPL

Welcome!

You found the main repository of tools,resources and script to build the open-source webcomic Pepper&Carrot. Also, the official Wiki is attached to this repository. This Wiki exist in the purpose to build together a better entertaining world around Pepper&Carrot, better character-design and better future episodes.

Screenshot gallery

1. The launcher icon within the main menu ( Linux Mint 17.2 Menu ) alt tag

2. The graphical main menu interface (left) calling for action "Edit all README.md" from all episodes, executed by Geany text editor(right) alt tag

3. After the selection of an episode in the menu, the submenu ( eg. episode 8, Pepper's Birthday Party ) and a list of service. On right, executing the renderfarm ; all graphics ( GFX ) and translations (LANG ) are up-to-date. alt tag

4. On left the submenu focused on episode 10 Summer special. On right, Nemo file manager opening the target folder direclty ( with RabbitCVS for GIT preview over the folder with emblems ). On right (under), the FTP update. Files changed or rendered are pushed to the main server this way. alt tag

Dependencies/Libraries

Only free/libre and open-sources tools :

  • Bash ( >= 4.3.11 ) Command line language in terminal.
  • Git ( >= 1.9.1 ) Utility to manage distributed revision control
  • Inkscape ( >= 0.91 ) Vector graphic software, for *.svg translation source files.
  • Imagemagick ( >= 6.7.7.10 ) Utility to manipulate images.
  • Zenity ( >= 3.8.0 ) Utility to create simple graphical user interface GTK dialog.
  • Gnome-terminal ( >= 3.6.2 ) Terminal software to access a shell in Gnome environment
  • Unzip ( >= 6.0 ) Utility to unzip *.zip files.
  • Wget ( >= 1.15 ) Utility to download files.
  • Diff ( >= 3.3 ) Utility to compare files,folders.
  • Parallel ( >= 20130922 ) Utility to exectute jobs in parallel.
  • Notify-send ( >= 0.7.6 ) Utility to send notification to operating system.
  • Lftp ( >= 4.6.3 ) Utility to perform FTP transfer.

for merge_translator.py

  • Python3
  • python3-unidecode

Note: I'm using Ubuntu 16.04 64bit with Unity desktop (default). The package versions here are installed with the package manager.

Install

The script install.sh can auto-install all for you (and also auto update/repair an instalation) :

1. Create on your disk an empty target folder with around 50GB free space:

cd $HOME
mkdir peppercarrot
cd peppercarrot

2. Clone the repository in a folder named 'scripts' and launch the install.sh script:

git clone https://github.com/Deevad/peppercarrot.git scripts
cd scripts
./install.sh

3. At the first run, the script should create a new configuration file config.sh along install.sh and stop inviting you to edit it. Here I edit it with the CLI editor 'nano' :

nano config.sh

Change export projectroot="/home/username/peppercarrot" to the root of your instalation folder ( where you created the 'peppercarrot' folder). Save the configuration file, and launch again the script again. Voilà, time for getting a coffee in front of long instalation process.

Note: You can also optionaly setup FTP login and password in this configuration file, if you want to sync with LFTP the local rendered pages to a distant server.

After install, here is how look like a basic file tree of a Pepper&Carrot project correctly installed :

peppercarrot/
├── fonts (git)
├── scripts (git)
├── webcomics
│   └── ep01_Potion-of-Flight
│   │   ├── lang (git)
│   │   └── zip
│   └── ep02_Rainbow-potions
│   │   ├── lang (git)
│   │   └── zip
│   └── ep03_The-secret-ingredients
│       ├── lang (git)
│       └── zip
├── wiki (git)
└── www-lang (git)

Note: On this example, only three episodes subfolder are visible to keep the example tree compact.

Usage

A launcher was copied into your system in $HOME/.local/share/applications/peppercarrot-menu.desktop .

All operating system's menu should catch this type of launcher. So, open your menu to access Peppercarrot main menu ( under the programming/development category ). An interface will pop-up and guide you to select an action ( eg. Select an episode, then render it ).

Update

Run again scripts/install.sh, or from the launcher GUI select the option 'update everything'.

License

Scripts

License GPLv3 or later. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program (LICENSE file at the root). If not, see http://www.gnu.org/licenses/.

Artworks

Artworks, Pepper&Carrot logo and title artwork in this repository are licensed under the Creative Commons Attribution 4.0 to David Revoy, www.peppercarrot.com.

Authors/Developers

  • David Revoy

  • Midgard

  • Mjtalkiewicz

(Note: Full details about contributions on the commit log)

Wiki

Authors of all modifications, corrections or contributions to the Wiki accept to release their work under the license: Creative Commons Attribution 4.0 International (CC BY 4.0). Read the wiki homepage for the full list of the contributors for the Wiki.