README.md 4.2 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

jreso's avatar
jreso committed
4
      Version: 0.90 (beta)
jreso's avatar
jreso committed
5
      Language: English, French
J Reso's avatar
J Reso committed
6
      Date: 06/2015
jreso's avatar
jreso committed
7 8 9 10 11 12 13 14 15
      Contact: contact_at_reso-nance.org
      Website: http://reso-nance.org/malinette
      Licence: GNU/GPL v3

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

## Description
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 will be (one day) also a very convenient suitcase with a computer, speakers, arduino and electronic circuits to test ideas and projects very quickly.

J Reso's avatar
J Reso committed
16
## Requirements
jreso's avatar
jreso committed
17
- Computer : a decent computer (>2005 is adviced)
jreso's avatar
jreso committed
18
- Operating system : should work on Mac OS X, MS Windows, and main distributions GNU/Linux
jreso's avatar
jreso committed
19 20 21
- Install Pure Data extended 0.43.4 : http://puredata.info/community/projects/software/pd-extended
- 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

J Reso's avatar
J Reso committed
22
## Installation and startup
23
1. Download the software: http://reso-nance.org/malinette/en/download
jreso's avatar
jreso committed
24 25 26 27 28
2. Extract anywhere
3. Open the "MALINETTE-en.pd" patch for English people and "MALINETTE-fr" for French People.
4. Clic on "? Help" or "? Aides" button if needed
5. Open examples to see how it works

J Reso's avatar
J Reso committed
29
## User instructions
jreso's avatar
jreso committed
30 31 32 33 34 35 36
You have two windows : the menu on the left, and the project on the right (a "patch" in Pure Data).
Basically, you can open examples or create your project.
When you open an example it close the last one.
When you want to start a project, the better way is to open the "00-new" project and fill it with some objects ("abstractions" is the right term in Pure Data).
You have helps in the main patch, see the "?" button and you can find some documentations in the "./docs" folder.
Have fun and report feedbacks and bugs at contact_at_reso-nance.org

J Reso's avatar
J Reso committed
37 38 39 40 41 42 43 44 45 46
## Contents
- ./abstractions	: all abstractions (in, out, filters, audio, video, numbers and master)
- ./data		: media files (images, videos, sounds, etc.)
- ./docs		: some documentations (license, todo, changes) and helps
- ./examples	: examples patchs to show and edit projects about interaction
- ./other		: tclplugins, scripts, processing codes, ...
- ./projects	: your projects folders
- MALINETTE-fr.pd	: open this patch to start the program (in french)
- MALINETTE-en.pd	: open this patch to start the program (in english)
- README.md
jreso's avatar
jreso committed
47

J Reso's avatar
J Reso committed
48 49 50 51 52 53 54
## Abstractions
- ./abstractions/audio : audio effects abstractions
- ./abstractions/numbers 	: data effects abstractions
- ./abstractions/video	: video effects abstractions
- ./abstractions/in 	: input abstractions (arduino, audio, video, mouse, key, kinect, ...)
- ./abstractions/master 	: abstractions to manage the main patch (audio, gem, arduino, buttons)
- ./abstractions/out 	: output abstractions (arduino, audio, video, ...)
jreso's avatar
jreso committed
55

J Reso's avatar
J Reso committed
56
## Coding rules
jreso's avatar
jreso committed
57 58 59 60 61 62 63 64
- file names with dash
- file names in lowercase
- default values
- test arguments
- a yellow toggle to switch on/off the abstraction
- 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
65
## Files formats (video, audio, 3d etc..)
jreso's avatar
jreso committed
66 67 68 69
Video : best format for video files (better performance in pd) is MJPEG, this compression is better packed in .avi for windows // .mov for mac.
Audio : Pure Data audio object use .aiff or .wav, except some librairies which use mp3 (malinette do not have mp3 player yet.).
3d: .obj is the right 3d-model-file you can import in Pure Data , you can create .obj from most of 3D software (like blender for instance).

J Reso's avatar
J Reso committed
70 71 72 73 74 75
## Some documentations (in french)
- Linux : http://doc.ubuntu-fr.org/
- Logiciels libres : http://www.framasoft.net/ 
- Pure Data : http://fr.flossmanuals.net/Puredata/
- Arduino : http://fr.flossmanuals.net/arduino/
- Forum de bidouilleurs : http://codelab.fr/