From 0bb8b92e99868f5d94e8a9e83b2880d8fa854889 Mon Sep 17 00:00:00 2001 From: Jak Daniels Date: Sat, 19 Jul 2014 14:33:38 +0100 Subject: [PATCH] Updated README.md, CHANGES.txt and CONTRIBUTORS.txt --- CHANGES.txt | 8 ++++++++ CONTRIBUTORS.txt | 3 ++- README.md | 22 ++++++++++++---------- 3 files changed, 22 insertions(+), 11 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index f59752c..11f4b60 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -12,3 +12,11 @@ 13/07/2011 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 diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 0ecda72..f938b2a 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -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 +* Jak Daniels - refactor for opensim 0.8.x and varregions diff --git a/README.md b/README.md index e4baf6d..24ed2c6 100644 --- a/README.md +++ b/README.md @@ -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 -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 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 @@ -27,13 +27,15 @@ 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 - flock-size = 100 the number of Boids to flock - 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 - 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 - tolerance = 5 how close to the edges of things can we get without being worried - + flock-size = 100 ;the number of Boids to flock + 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 + 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 + 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