Skip to content

Commit

Permalink
remove readme because it isn't very up to date
Browse files Browse the repository at this point in the history
  • Loading branch information
JacquesLucke committed Jun 21, 2015
1 parent d5f925d commit da6e175
Showing 1 changed file with 1 addition and 41 deletions.
42 changes: 1 addition & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1 @@
http://animation-nodes-documentation.readthedocs.org/en/latest/

##How to make my own nodes


### Overview
To create your own node you have to follow 2 simple steps:

1. Copy the file of an existing node and change to you needs.
2. Register the node in the _nodes/mn_node_list.py_ file.

All node files are in the subdirectories of the Folder named _nodes_.

### the class
The Code itself is very self-explanatory.
You have to change:
* the class Name too something that fits the purpose of your node
* the _bl_idname_ variable: you Need this later to Register the node
* the _bl_label_ variable: the user will see this in the add menu

### _init_
The _init_ function is for defining the sockets. In other nodes you see exactly how this has to look like.
There are a few different types of sockets (the list will probably get longer over time):
* StringSocket -> Text
* ObjectSocket -> Object names
* IntegerSocket -> Whole Numbers
* FloatSocket -> All Numbers
* VectorSocket -> Vector with an x, y and z component
* GenericSocket -> allows all types

### execute
Here you add the code that executes when the node is used.
It gets a variable named _input_ as Parameter. This is a dictionary which contains your input socket names as keys.
This function always returns a dictionary that should be called _output_. The keys of this dictionary are equivalent to the output socket names you defined in the _init_ function.

### Registration
Open the _mn_node_list.py_ file and write your _bl_idname_ in the corresponding category or define you own category. This shouldn't be more than a one-line-change.

### summary
The best way to implement new nodes is to look at the existing ones :D

http://animation-nodes-documentation.readthedocs.org/en/latest/

4 comments on commit da6e175

@oenvoyage
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will you still be working on this project? It is really great and promising.

@JacquesLucke
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yees. I'm still working on it. Just look at the refactor branch. more than 250 commits within the last few days
Unfortunally it will still take a while until I can merge all these changes into master

@oenvoyage
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right I did not see the refactor branch! I am testing it right now.. Thank you for the great work

@JacquesLucke
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the refactor branch is not in a usable state! But have fun working with the master version :)

Please sign in to comment.