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

Update documentation

pull/1/merge
Jak Daniels 2014-12-31 21:13:16 +00:00
parent 80dfa5a0d6
commit b879157683
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,6 +1,7 @@
INonSharedRegion Module - ability to control flocks of prims within an OpenSim scene. INonSharedRegion Module - ability to control flocks of prims within an OpenSim scene.
***This module is currently broken, removing prims from the scene on disable does not work**** ***Bugs:
*** Inworld commands only work if the console region is changed to the current region
To build from source To build from source
@ -12,7 +13,7 @@ then xbuild, or build within Visual Studio / Monodevelop to produce the binaries
Remember you need an .ini file in bin/addon-modules/OpenSimBirds/config/ Remember you need an .ini file in bin/addon-modules/OpenSimBirds/config/
OpenSimBirds has no external dependencies other than the dlls currently included in opensim. OpenSimBirds has no external dependencies other than the dlls currently included in opensim.
The project generates a single dll - OpenSimBirds.Modules.dll which is copied into opensim/bin as part of the build step The project generates a single dll - OpenSimBirds.Module.dll which is copied into opensim/bin as part of the build step
Configuration Configuration
@ -52,9 +53,9 @@ Here is an example config:
Various runtime commands control the flocking module behaviour - described below. These can either be invoked Various runtime commands control the flocking module behaviour - described below. These can either be invoked
from the Console or in world by directing them to a chat channel. To specify which channel to use: from the Console or in world by directing them to a chat channel. You can specify which channel to use in the .ini:
chat-channel = 118 the chat channel to listen for Bird commands on BirdsChatChannel = 118 the chat channel to listen for Bird commands on

17
config/OpenSimBirds.ini.example
View File

@ -1,16 +1,17 @@
;; Set the Birds settings per named region ;; Set the Birds settings per named region
[Test Region 1] [Test Region 2]
BirdsEnabled = True ;set to false to disable the module in this region BirdsEnabled = True ;set to false to disable the module in this region
BirdsFlockSize = 100 ;the number of birds to flock BirdsChatChannel = 118 ;which channel do we listen on for in world commands
BirdsMaxSpeed = 3 ;how far each bird can travel per update BirdsFlockSize = 20 ;the number of birds to flock
BirdsMaxForce = 0.25 ;the maximum acceleration allowed to the current velocity of the bird BirdsMaxSpeed = 1.5 ;how far each bird can travel per update
BirdsMaxForce = 0.20 ;the maximum acceleration allowed to the current velocity of the bird
BirdsNeighbourDistance = 25 ;max distance for other birds to be considered in the same flock as us BirdsNeighbourDistance = 25 ;max distance for other birds to be considered in the same flock as us
BirdsDesiredSeparation = 20 ;how far away from other birds we would like to stay BirdsDesiredSeparation = 10 ;how far away from other birds we would like to stay
BirdsTolerance = 5 ;how close to the edges of things can we get without being worried BirdsTolerance = 5 ;how close to the edges of things can we get without being worried
BirdsBorderSize = 5 ;how close to the edge of a region can we get? BirdsBorderSize = 5 ;how close to the edge of a region can we get?
BirdsMaxHeight = 256 ;how high are we allowed to flock BirdsMaxHeight = 75 ;how high are we allowed to flock
BirdsPrim = seagull01 ;By default the module will create a flock of plain wooden spheres, BirdsPrim = SeaGull1 ;By default the module will create a flock of plain wooden spheres,
;however this can be overridden to the name of an existing prim that ;however this can be overridden to the name of an existing prim that
;needs to already exist in the scene - i.e. be rezzed in the region. ;needs to already exist in the scene - i.e. be rezzed in the region.