README.md 4.57 KB
Newer Older
J Reso's avatar
J Reso committed
1
# La Malinette
jreso's avatar
jreso committed
2
A Free Open Source Kit To Simplify Programming Interactivity
jreso's avatar
jreso committed
3

J Reso's avatar
J Reso committed
4
- Version: 1.0.beta
resonance's avatar
resonance committed
5
- Languages: English, French, Spanish (~)
6
- Date: 21/10/2016
J Reso's avatar
J Reso committed
7 8 9
- Contact: contact_at_reso-nance.org
- Website: http://reso-nance.org/malinette
- Licence: GNU/GPL v3
jreso's avatar
jreso committed
10

resonance's avatar
resonance committed
11
Special thanks for all Pure Data developers, we've taken some good ideas from few great projects (pdmtl abstractions, DIY2, ...)
jreso's avatar
jreso committed
12 13

## Description
J Reso's avatar
J Reso committed
14
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 extended. 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.
jreso's avatar
jreso committed
15

J Reso's avatar
J Reso committed
16
## Features
resonance's avatar
resonance committed
17 18
- In english : http://reso-nance.org/malinette/en/software/features
- In french : http://reso-nance.org/malinette/fr/software/features
J Reso's avatar
J Reso committed
19

J Reso's avatar
J Reso committed
20
## Requirements
jreso's avatar
jreso committed
21
- Computer : a decent computer (>2005 is adviced)
22 23
- Operating system : should work on Mac OS X, MS Windows and main GNU/Linux distributions.
- Install Pd-extended : http://puredata.info/downloads/pd-extended
jreso's avatar
jreso committed
24 25
- Optional, if you want to use an Arduino, download the Arduino 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

resonance's avatar
resonance committed
26
## Pure Data dependencies
resonance's avatar
resonance committed
27
If you have not Pure Data Extended, here you can find our dependencies :  creb, initbang, Gem, zexy, cyclone, moonlib, moocow, hcs, tof, comport, iemlib, iemnet or oscx or mrpeach, markex, motex, ggee, list-abs, mapping, pix_fiducialtrack, sigpack, pmpd, purepd, iemguts
resonance's avatar
resonance committed
28 29

You should download them with the new pd.0.47 feature "Find externals" (Deken).
J Reso's avatar
J Reso committed
30

J Reso's avatar
J Reso committed
31
## Installation and startup
J Reso's avatar
J Reso committed
32 33
1. Download the software:
    - The most recent version : https://git.framasoft.org/resonance/malinette
resonance's avatar
resonance committed
34
    - Release : http://reso-nance.org/malinette/
jreso's avatar
jreso committed
35
2. Extract anywhere
36
3. Open the "MALINETTE.pd"
J Reso's avatar
J Reso committed
37
4. Open Manual examples to see how it works
jreso's avatar
jreso committed
38

J Reso's avatar
J Reso committed
39
## User instructions
J Reso's avatar
J Reso committed
40
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. When you want to start a project, the better way is to open the "new" project and fill it with some objects. Clic on the "?" buttons to find all objects of a category. You can also find some documentations in the "./docs" folder.
J Reso's avatar
J Reso committed
41

J Reso's avatar
J Reso committed
42
Have fun and report feedbacks and bugs at contact_/at/_reso-nance.org.
jreso's avatar
jreso committed
43

44
## Content
J Reso's avatar
J Reso committed
45 46 47 48 49 50 51 52
- ./abstractions    : all objects (audio, core, in, numbers, out, seq, video)
- ./medias          : media files (images, videos, sounds, etc.)
- ./docs            : some documentations (license, todo, changes) and OVERVIEW.pdf help
- ./examples        : examples patchs to show and edit projects about interaction
- ./other           : tclplugins, scripts, processing codes, ...
- ./projects        : your projects folders
- MALINETTE.pd      : open this patch to start the program (in french)
- preferences.txt   : preferences file with global setup (language, level, screen size, project folder)
resonance's avatar
resonance committed
53
- README.md
jreso's avatar
jreso committed
54

J Reso's avatar
J Reso committed
55
## Abstractions
J Reso's avatar
J Reso committed
56 57 58 59 60 61 62
- ./abstractions/audio      : audio effects
- ./abstractions/core       : core functions (menu buttons, media masters, tools, ...)
- ./abstractions/in         : inputs (arduino, audio, video, mouse, key, kinect, ...)
- ./abstractions/numbers    : numbers effects
- ./abstractions/out        : outputs (arduino, audio, video, ...)
- ./abstractions/seq        : sequencers tools
- ./abstractions/video      : video effects
jreso's avatar
jreso committed
63

J Reso's avatar
J Reso committed
64
## Coding rules
jreso's avatar
jreso committed
65 66 67 68
- file names with dash
- file names in lowercase
- default values
- test arguments
69
- a toggle to switch on/off the abstraction
jreso's avatar
jreso committed
70 71 72
- when an extra object is used from pd-extended, put the library as a prefix. Ex: [tof/menubutton] (to discuss)
- if they are more than 2 or 3 inlets, a good practice would be to use the cold inlet (on the right) to pass messages throught it and route them with a [route] object.

J Reso's avatar
J Reso committed
73
## Files formats (video, audio, 3d etc..)
resonance's avatar
resonance committed
74 75 76
- 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).
- 3d: .obj is the 3d-model-file you can import in Pure Data, you can create .obj from most of 3D software (like Blender for instance).
jreso's avatar
jreso committed
77

J Reso's avatar
J Reso committed
78 79 80 81
## Some documentations (in french)
- Pure Data : http://fr.flossmanuals.net/Puredata/
- Arduino : http://fr.flossmanuals.net/arduino/
- Forum de bidouilleurs : http://codelab.fr/