Module
/
OpenSimBirds
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README.md, CHANGES.txt and CONTRIBUTORS.txt

pull/1/merge
Jak Daniels 2014-07-19 14:33:38 +01:00
parent 184fa20e2c
commit 0bb8b92e99
3 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGES.txt
View File

@ -12,3 +12,11 @@
13/07/2011 13/07/2011
added more documentation added more documentation
10/07/2014
forked from https://github.com/jonc/osboids
17/07/2014
refactored the code
added some more config items to set the region border size (no go zone) and the max height
added support to the module for varregions

3
CONTRIBUTORS.txt
View File

@ -1,4 +1,5 @@
The following people have contributed to the development of the osboids module The following people have contributed to the development of the OpenSimBoids module
* Jon Cundill - initial implementation * Jon Cundill - initial implementation
* Jak Daniels - refactor for opensim 0.8.x and varregions

20
README.md
View File

@ -1,14 +1,14 @@
Region Module - ability to control flocks within an OpenSim scene Region Module - ability to control flocks of prims within an OpenSim scene
To build from source To build from source
Add osboids source tree under opensim/addon-modules Add OpenSimBoids source tree under opensim/addon-modules
./runprebuild.sh against opensim root to build this module into the solution ./runprebuild.sh against opensim root to build this module into the solution
then xbuild, or build within Visual Studio / Monodevelop to produce the binaries then xbuild, or build within Visual Studio / Monodevelop to produce the binaries
osboids has no external dependencies other than the dlls currently included in opensim. OpenSimBoids has no external dependencies other than the dlls currently included in opensim.
The project generates a single dll - Flocking.dll which is copied into opensim/bin as part of the build step The project generates a single dll - Flocking.dll which is copied into opensim/bin as part of the build step
@ -27,12 +27,14 @@ removing the Boids group or setting enabled = false will switch off the module
In addition various config parameters are available to control the flock dynamics In addition various config parameters are available to control the flock dynamics
flock-size = 100 the number of Boids to flock flock-size = 100 ;the number of Boids to flock
max-speed = 3 how far each boid can travel per update max-speed = 3 ;how far each boid can travel per update
max-force = 0.25 the maximum acceleration allowed to the current velocity of the boid max-force = 0.25 ;the maximum acceleration allowed to the current velocity of the boid
neighbour-dist = 25 max distance for other boids to be considered in the same flock as us neighbour-dist = 25 ;max distance for other boids to be considered in the same flock as us
desired-separation = 20 how far away from other boids we would like to stay desired-separation = 20 ;how far away from other boids we would like to stay
tolerance = 5 how close to the edges of things can we get without being worried tolerance = 5 ;how close to the edges of things can we get without being worried
border-size = 5 ;how close to the edge of a region can we get?
max-height = 256 ;how high are we allowed to flock
By default the module will create a flock of plain wooden spheres, however this can be overridden By default the module will create a flock of plain wooden spheres, however this can be overridden