Skip to content

Latest commit

 

History

History
196 lines (176 loc) · 7.69 KB

README.md

File metadata and controls

196 lines (176 loc) · 7.69 KB
Raw

Version

A tool for converting Scratch projects into Catrobat programs.

Catrobat is a visual programming language and set of creativity tools for smartphones, tablets, and mobile browsers. Catrobat programs can be written by using the Catroid programming system on Android phones and tablets, using Catroid, or Catty for iPhones.

For more information oriented towards developers please visit our developers page.

License

License of our project (mainly AGPL v3).

The Following License Header should be used for all python and java source files.

License Header for Python source files

#  ScratchToCatrobat: A tool for converting Scratch projects into Catrobat programs.
#  Copyright (C) 2013-2017 The Catrobat Team
#  (http://developer.catrobat.org/credits)
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Affero General Public License as
#  published by the Free Software Foundation, either version 3 of the
#  License, or (at your option) any later version.
#
#  An additional term exception under section 7 of the GNU Affero
#  General Public License, version 3, is available at
#  http://developer.catrobat.org/license_additional_term
#
#  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 Affero General Public License for more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with this program.  If not, see http://www.gnu.org/licenses/.

License Header for Java source files

/*
 * ScratchToCatrobat: A tool for converting Scratch projects into Catrobat programs.
 * Copyright (C) 2013-2017 The Catrobat Team
 * (http://developer.catrobat.org/credits)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * An additional term exception under section 7 of the GNU Affero
 * General Public License, version 3, is available at
 * http://developer.catrobat.org/license_additional_term
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/.
 */

#Setup for Debian (Wheezy 7.x):

  • First of all you have to refresh your package lists via:
sudo apt-get update
  • Now install python (if not already installed) (minimum allowed version 2.7):
sudo apt-get install python
  • Install sox via aptitude (needed for sound conversion):
sudo apt-get install sox
  • Install nvm via wget:
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash
  • Now close and reopen the terminal. Then install Node.js via nvm:
nvm install v14.5.0
  • This step is optional, only do this if nvm doesn't set the default node version to 14.5.0:
nvm alias default 14.5.0
  • Verify that Node.js version 14.5.0 and npm version 6.14.5
node -v
npm -version
  • Install svg2png via npm (needed for svg conversion):
npm install svg2png -g
  • Jython 2.7 requires java version 1.8 or later. To determine the currently installed java version run the following command on your shell:
java -version
  • If no java version is installed make sure to install at least java 1.8 (in this guide we will install java 1.11)
sudo apt-get install openjdk-11-jre
  • Now, download jython e.g. by using wget (at least version 2.7):
wget -O jython-installer-2.7.0.jar http://search.maven.org/remotecontent?filepath=org/python/jython-installer/2.7.0/jython-installer-2.7.0.jar
  • To install jython issue the following command and fill in the parameters listed below:
sudo java -jar jython-installer-2.7.0.jar --console
[...]
Please select your language [E/g] >>> E
Do you want to read the license agreement now ? [y/N] >>> y
[...]
Do you accept the license agreement ? [Y/n] >>> Y
The following installation types are available:
1. All (everything, including sources)
2. Standard (core, library modules, demos and examples, documentation)
3. Minimum (core)
9. Standalone (a single, executable .jar)
Please select the installation type [ 1 /2/3/9] >>> 2
Do you want to install additional parts ? [y/N] >>> N
Do you want to exclude parts from the installation ? [y/N] >>> N
Please enter the target directory >>> /usr/jython
Unable to find directory /usr/jython, create it ? [Y/n] >>> Y
Please enter the java home directory (empty for using the current java runtime) >>>
[...]
Please confirm copying of files to directory /usr/jython [Y/n] >>> Y
[...]
Do you want to show the contents of README ? [y/N] >>> y
[...]
Please press Enter to proceed >>>
Congratulations! You successfully installed Jython 2.7 to directory /usr/jython.
  • Install git via apt-get:
sudo apt-get install git
  • Clone this repository:
git clone https://github.com/Catrobat/ScratchToCatrobat.git
  • Go to the ScratchToCatrobat directory:
cd ScratchToCatrobat
  • Open jython's registry file and change the following line:
python.security.respectJavaAccessibility = true

to:

python.security.respectJavaAccessibility = false
  • (This step is optional, but highly recommended for developers.) For your convenience, we'd recommend you to create a new (empty) local custom config file called "environment.ini" in the "config" directory. It automatically inherits from the original config file "default.ini" and is ignored by the ".gitignore" settings. Thus, every parameter you will later define in your "environment.ini" file will automatically overwrite the corresponding parameter coming from the "default.ini" file, i.e. new parameters must be defined in the "default.ini" file at first (due to compatibility reasons) and thereafter in your local "environment.ini" file. Keep in mind that it does not make sense to put in new parameters into the "environment.ini" that do not exist in the "default.ini", since your local "environment.ini" file is not part of the Git repository as already mentioned before.
touch ./config/environment.ini
  • Make the converter script executable:
chmod +x ./run
  • You can now start the conversion process, e.g. by issuing the following command:
./run http://scratch.mit.edu/projects/10205819/ ./data/output

Here, the first parameter tells the script which scratch project should be converted. The second parameter (optional) represents the (absolute or relative) path to the output folder where the converted Catrobat program is finally stored.

For more details on how to use the script, please execute the following line:

./run --help

To be able to run the test script run_tests, just make it executable and run it:

chmod +x ./run_tests
./run_tests

Basically the setup is now finished, but if you want to use an IDE check the following link: https://confluence.catrob.at/display/S2CC/Setting+up+a+development+environment