Write documentation #59

New issue

Closed

opened 2016-12-25 15:16:05 +01:00 by nik · 18 comments

nik commented

2016-12-25 15:16:05 +01:00

(Migrated from edugit.org)

For the real release, we need full documentation of the API, examples, etc.

Maybe we should start using Sphinx.

For the real release, we need full documentation of the API, examples, etc. Maybe we should start using Sphinx.

nik commented

2017-03-14 15:20:13 +01:00

(Migrated from edugit.org)

1. Basic concepts
  1.1. Games / Game Cartridges
  1.2. Worlds
  1.3. Player
    1.3.1. Inventory
  1.4. Game object types
2. Create a new game
  2.1. On the command line
    2.1.1. veripeditus-newgame
3. Constants in game package
  3.1. Meta-data about game
    NAME
    AUTHOR
    VERSION
    LICENSE
    DESCRIPTION
  3.2. Game-wide game object configuration
    HIDE_SELF
    VISIBLE_RAD_PLAYERS
    VISIBLE_RAD_ITEMS
    VISIBLE_RAD_NPCS
4. Describing game objects
  4.1. Creating a new game object
    4.1.1. Player
    4.1.2. Item
    4.1.3. NPC
    4.1.4. Location
  4.3. Defining basic attributes
    Default name, image,…
  4.2. Defining where to spawn
    4.2.1. Spawning at a point (lat lon)
    4.2.2. Spawning inside a rectangle
    4.2.3. Spawning inside a polygon
    4.2.4. Spawning at OSM objects
  4.3. Configuring interaction
    4.3.1. distnace_max, owned_max,…
    4.3.2. talkable, collectible, handoverable, placeable, passable
  4.4. Handling basic events
    4.4.1. on_talk
    4.4.2. on_collected
    4.4.3. on_pass
    4.4.4. on_handedover
    4.4.5. on_placed  
  4.4. Reacting inside events
    4.4.1. self.say
    4.4.2. Handling inventory
      has_item, has_items, drop_item, drop_items, new_item,…
    4.4.3. Attributes
  4.5. Defining allowed actions
    4.5.1. may_handover
    4.5.2. may_accept_handover
    4.5.3. may_collect
    4.5.4. may_place
    4.5.5. may_talk
    4.5.6. may_pass
5. Advanced modification of game logic
  5.1. Overriding default code
    5.1.1. Overriding spawn()
    5.1.2. Overriding isonmap()

``` 1. Basic concepts 1.1. Games / Game Cartridges 1.2. Worlds 1.3. Player 1.3.1. Inventory 1.4. Game object types 2. Create a new game 2.1. On the command line 2.1.1. veripeditus-newgame 3. Constants in game package 3.1. Meta-data about game NAME AUTHOR VERSION LICENSE DESCRIPTION 3.2. Game-wide game object configuration HIDE_SELF VISIBLE_RAD_PLAYERS VISIBLE_RAD_ITEMS VISIBLE_RAD_NPCS 4. Describing game objects 4.1. Creating a new game object 4.1.1. Player 4.1.2. Item 4.1.3. NPC 4.1.4. Location 4.3. Defining basic attributes Default name, image,… 4.2. Defining where to spawn 4.2.1. Spawning at a point (lat lon) 4.2.2. Spawning inside a rectangle 4.2.3. Spawning inside a polygon 4.2.4. Spawning at OSM objects 4.3. Configuring interaction 4.3.1. distnace_max, owned_max,… 4.3.2. talkable, collectible, handoverable, placeable, passable 4.4. Handling basic events 4.4.1. on_talk 4.4.2. on_collected 4.4.3. on_pass 4.4.4. on_handedover 4.4.5. on_placed 4.4. Reacting inside events 4.4.1. self.say 4.4.2. Handling inventory has_item, has_items, drop_item, drop_items, new_item,… 4.4.3. Attributes 4.5. Defining allowed actions 4.5.1. may_handover 4.5.2. may_accept_handover 4.5.3. may_collect 4.5.4. may_place 4.5.5. may_talk 4.5.6. may_pass 5. Advanced modification of game logic 5.1. Overriding default code 5.1.1. Overriding spawn() 5.1.2. Overriding isonmap() ```

nik commented

2017-05-09 23:58:10 +02:00

(Migrated from edugit.org)

Mentioned in commit e29484c708

Mentioned in commit e29484c708cc46137baea41c056728a096f74888

nik commented

2017-05-09 23:58:11 +02:00

(Migrated from edugit.org)

Mentioned in commit 4e5fb25c75

Mentioned in commit 4e5fb25c75bd52718dae152ae43b5e80eaab7697

nik commented

2017-05-09 23:58:11 +02:00