README.md 6.28 KB
Newer Older
Jérôme Abel's avatar
Jérôme Abel committed
1
2
3
# La Malinette - IDE
A Free Open Source Kit To Simplify Programming Interactivity

Jérôme Abel's avatar
Jérôme Abel committed
4
- Version: 2.1
5
- Languages: English, French, Spanish (for interface, examples and manuals)
6
- Authors: Reso-nance Numérique, Jérôme Abel
Jérôme Abel's avatar
Jérôme Abel committed
7
- Contact: contact_at_reso-nance.org
8
- Website: http://malinette.info
9
- Development: http://framagit.org/malinette
Jérôme Abel's avatar
Jérôme Abel committed
10
11
12
13
14
- Licence: GNU/GPL v3

Special thanks for all Pure Data developers. We've taken some good ideas from few great projects (pdmtl abstractions, DIY2, rjdj, ...).

## Description
Jérôme Abel's avatar
Jérôme Abel committed
15
Malinette is an all-in-one solution, a rapid prototyping tool to show and make simple interaction and multimedia projects. It is a software and a hardware set. The software is based on Pure Data Vanilla. It is also a very convenient suitcase and wood boxes with sensors, actuators, Arduino, Teensy and electronic components to test ideas and projects very quickly.
Jérôme Abel's avatar
Jérôme Abel committed
16

17
18
19
20
## Architecture
The Malinette software is divided in three parts from newbies to advanced users:
- [malinette-soft](https://framagit.org/malinette/malinette-soft): the standalone way to use the Malinette, a single folder containing Pure Data, externals, malinette and a startup script;
- [malinette-ide](https://framagit.org/malinette/malinette-ide): a framework and an interface to learn programming and rapid prototyping;
21
- [malinette-abs](https://framagit.org/malinette/malinette-abs): a set of abstractions to use Pure Data easily;
22

23
24
25
26
## Other Resources
- BrutBoX. Note that the software is also used for the [BrutBox](https://git.framasoft.org/resonance/brutbox/) musical interface.
- Hardware. You will find also a [malinette-hw](https://framagit.org/malinette/malinette-hw) repository that contains hardware designs.
- Documentations. [malinette-docs](https://framagit.org/malinette/malinette-docs)
27

Jérôme Abel's avatar
Jérôme Abel committed
28
## Requirements
29
- Computer: a decent computer (>2008 is adviced)
Jérôme Abel's avatar
Jérôme Abel committed
30
- Operating system: should work on Mac OS X, MS Windows and main GNU/Linux distributions.
Jérôme Abel's avatar
Jérôme Abel committed
31
- Pure Data: >0.51 version
32
- Dependencies (externals): bassemu~ comport cyclone ext13 Gem ggee hcs hid (or hidin for windows) iemguts iemlib list-abs mapping maxlib moocow pix_fiducialtrack pmpd puremapping purepd sigpack tof zexy
33

34
See the "INSTALL.md" file for installation advices.
35

36
## Arduino
37
38
39
40
If you want to use an Arduino, download the [Arduino-IDE software](http://www.arduino.cc/en/Main/Software).

Plug the USB board, install drivers if required, and upload the "StandardFirmata" sketch from the Arduino software : Menu File > Examples > Firmata > StandardFirmata

Jérôme Abel's avatar
Jérôme Abel committed
41
On Windows 10 or Mac OS X, we note that the Arduino/Leonardo board and Firmata does not work with [pduino]. So you should convert it in MIDI (see [malinette-hw](https://framagit.org/malinette/malinette-hw)) or use a Arduino/UNO board for instance.
42

43
44
Note: For Windows 8, disable Driver Signature Verification.

45
## Updates
46
Few malinette-ide folders could be stored in the same folder if they don't have the same name. Keep in mind that is a good practice to rename old "malinette-ide" to keep your projects and data.
47
48

So, for malinette-soft users, you can keep your old malinette-ide folder and pick a new one to be up-to-date.
Jérôme Abel's avatar
Jérôme Abel committed
49

50
51
52
## Configurations

### Resize patchs
Jérôme Abel's avatar
Jérôme Abel committed
53
Sometimes, depends on operating system, the menu and patches don't show as you wish. After copy a backup of "malinette-ide", you can resize all patches with the "tools/resize_patches.sh" script. Edit it to find your specific dimensions.
54
55
56
57

### Preferences
In the "preferences/preferences.txt" file you can change the lang of the interface, the port of an Arduino, the screen size of video rendering. We added extra features like EDIT to not allow edit mode on the menu, and 10BITS to allow 10 bits sensor for BrutBox Midi interface.

Jérôme Abel's avatar
Jérôme Abel committed
58
Another setup could be to change the list of objects, it is possible by editing the "preferences/malinette-objects-list.txt".
59

60
61
62
## User instructions
- Open the "MALINETTE.pd" for the standard version or the "BRUTBOX.pd" for the Brutbox version.
- Open Manual examples to see how it works
63

64
You have two windows : the menu on the left and the project window on the right (called a "patch" in Pure Data). Basically, you can open examples or create your project. Clic on the "?" buttons to find all objects of a category. You can also find some documentations in the "./docs" folder.
65

Jérôme Abel's avatar
Jérôme Abel committed
66
To start a project, first way is to open the "new" patch, fill it with some objects, and save it with an another name. A more rich way is to go to "malinette-ide/projects", copy and paste the "malinette-default", and rename it. Next, go to "malinette-ide/preferences" and edit "preferences.txt" file with a text editor (on windows, notepad seems better that bloc notes). Change the "malinette-folder: malinette-default" by "malinette-folder: my-projects" for instance. Next time you will open MALINETTE.pd it will show you the contents of "my-projects". The structure of a project folder must be :
67
68
69
- my-projects/new.pd: the start patch
- .........../data: to store data, presets, medias, ...
- .........../abs: to store your abstractions
70

Jérôme Abel's avatar
Jérôme Abel committed
71
## Content
Jérôme Abel's avatar
Jérôme Abel committed
72
- ./abs    			: all objects (audio, in, numbers, out, seq, video)
Jérôme Abel's avatar
Jérôme Abel committed
73
- ./docs            : images for documentation (see [malinette-docs](https://framagit.org/malinette/malinette-docs) for objects and exemples documentations)
Jérôme Abel's avatar
Jérôme Abel committed
74
- ./examples        : examples and manual patches, also some processing examples
Jérôme Abel's avatar
Jérôme Abel committed
75
- ./preferences     : preferences file, language translations, logos and dependencies
Jérôme Abel's avatar
Jérôme Abel committed
76
- ./projects        : your projects folders
77
78
79
- ./tools         	: scripts to make helps, download packages, tclplugins, ..
- MALINETTE.pd      : open this patch to start the ide
- BRUTBOX.pd      	: beginner version with BrutBox MIDI interface
Jérôme Abel's avatar
Jérôme Abel committed
80
81
82
83

## Files formats (video, audio, 3d etc..)
- Video : best format for video files (better performance in pd) is MJPEG, this compression is better packed in .avi for windows and .mov for mac.
- Audio : Pure Data audio objects use .aiff or .wav, except some librairies which use mp3 (we do not have mp3 player yet).
Jérôme Abel's avatar
Jérôme Abel committed
84
- 3d: .obj is the 3d-model-file you can import in Pure Data, you can create .obj from most of 3D software (like Blender).
Jérôme Abel's avatar
Jérôme Abel committed
85

Jérôme Abel's avatar
Jérôme Abel committed
86
87
88
## Some documentations
- Pure Data and Arduino: http://flossmanuals.net/ (french and english)
- French forum: http://codelab.fr/
89
- English Pure Data forum: https://forum.pdpatchrepo.info/
90
91
- Youtube channel : https://www.youtube.com/channel/UCqd_bN13_IeVkXg83jLTTWg
- Pd-list: https://lists.puredata.info/pipermail/pd-list/