[simspark-devel] Documentation: SimSpark User's Manual

[Marian B. <mar...@gm...>]

Hi all

I would like to open discussion about SimSpark User's Manual [1]. I think it
need some revision :). I did some change[2] (also this changes are in SVN,
revision 42):

 

Page1:

- add my name :)

- change version to 1.2

- change date to February 2009

 

Page6,12,31:

- change agentspark to rcssagent3d (in entire manual)

 

Page8

- comment chapter 2.5 Available Robot Model

 

Page 9,10,11

- many changes in chapter 3.1.

 

Page 22

- change rsg/agent/soccerbot056.rsg to rsg/agent/nao/nao.rsg

- comment chapter 4.4 Setup scripts

 

Page 31

- change name of chapter from Agentspark to Rcssagent3d , also change file
from agentspark.tex to rcssagent3d

 

Page 36

- comment chapter 7.1.5 Setup Script

 

Page 37

- change path to the rsg models (from app/simspark/rsg/agent to
rcssserver3d/data/rsg/agent/

 

Page 43

- change path to the rsg nao model (from app/simspark/rsg/agent/nao to
rcssserver3d/data/rsg/agent/nao

 

Page 49

- add  <mailto:sse...@li...>
sse...@li... to new line

 

Also in Bibliography I found Project report Robocup treti rozmer from
M.Lekavy. This project report described old effectors and perceptors of
version rcssserver (0.5.2 - sphere model). In my graduation theses [3] (not
complete, in page 3 I wrote a small annotation in English language) I
describe in detail all perceptors and effectors of SoccerBot and Nao,
marginally describe some scripts (like spark.rb), introduce humanoid models
like Soccerbot 0.5.5, 0.5.6 and Hoap, soccer modes etc. I think it's a good
material for Simspark in Slovak language and I suggest to add this project
report in to the bibliography (instead of Project report of Mr. Lekavy, btw
I think he will be opponent of my graduation theses, because I'm from the
same college :) ). So what do you think?

 

I think we should add chapter ToDo in the end (or nearly end) of the manual,
what is missing (include commented part of manual).

 

Some questions:

Page 23:

The x and y coordinates define the position on the field with respect to the
coordinate system of figure ???. 

- it is mean, coordinates in own side of player in the soccer playfield?

 

Page 33, chapter 7.1.2

- It describe the dimensions of the soccer field. Now exists two version of
field: equivalent of FIFA rules - soccersim.rb and actual competitions
settings - naosoccersim.rb. Should we describe both? Or it's ok as is.

 

If you have any question about this change or you will have new idea, how to
improve this manual, type here.

 

[1] http://student.fiit.stuba.sk/~buchta02/simspark/user-manual_original.pdf


[2] http://student.fiit.stuba.sk/~buchta02/simspark/user-manual.pdf 

[3] http://student.fiit.stuba.sk/~buchta02/simspark/DP2.pdf 

 

Best Regards

Marian Buchta