removed GNU Autotools build system
[rofl0r-obeditor.git] / ressources / manual_stage.txt
blob87a807a2b44caf09fdd933207681f3c7fcab0038
1                 Welcome in the stage editor.
4 --------------------------------------
5         WARNINGS
6         
7 First keep in mind that :
8  1 - Although the best efforts are made to offer you a view that match the one made by OpenBOR, there could be some differences.
9  2 - This is only a tool for moding, and there is no garantee that there will be no errors when launching OpenBOR (example : the panels must have the same width, if not, although the editor will not prompt you, OpenBOR will crash).
11  So, you have to read the doc (http://lavalit.com)
14 --------------------------------------
15         THE MENUS
16         
17 LOAD/SAVE
18 <RELOAD ALL> : will reload the Sets, and the Stage of the Set. NOT the entities.
21 SETS
22 Before editing you have to choose/add a new set for your mod.
23 - <Change Current Set> show you all avalaible sets.
24 - <SET Properties> permit edit common set properties of the current set.
27 STAGES
28 Before editing you also have to choose/add a new stage in the current set.
29 - <STAGE Declaration Properties> permit edit properties of the stage that appears in the SET file.
30 - <STAGE Properties> permit editing commom properties of the stage.
31 - <Change Current STAGE> show you all avalaible stages of the current set.
33 SCENE
34 - <BACKGROUND> permit add/edit the main background image.
35 - <BG LAYERS> Show you a view of the background 
36         (NOTE : you must have a valid background image to access here)
37         You can add/delete/reorder/edit the background layers of your stage
38 - <PANELS> SubMenu show you the current panels of your stage
39         The <ReOrder> item permit editing the panels order.
40 - <FRONT PANELS> SubMenu show you the current front panels of your stage.
41         The <Edit> item offer a view and permit add/delete/reorder/edit the frontpanels.
42 - <Test Scene> Is for checking purpose only. It offers a view with all Scene elements : Backgrounds / Panels / Front Panels.
44 OBJECTS
45 - <Duplicate>/<Delete>/<Properties> applies on the object(s) currently selected in the main view.
46 - <Sort Objects with At> is a tool for reorder all objects with a "AT" attribute of the stage. The editor will keep a stage withe well-ordered AT-objects, well ordered.
49 --------------------------------------
50         THE STAGE VIEW
51         
52 Composed with 2 elements, the upper is a zoomable view (call it the VIEW), the lower is the map view.
53 In the VIEW you can
54 - Select objects :
55    By clicking them, or use a rectangle selection. You can Add/Rm object to selection with the CTRL or SHIFT logic.
56    Objects with At property will show ther AT position when selected.
57    When Selected, objects appears in VIEW and MAP with red borders.
58 - Move selected objects:
59   By dragging them with the mouse or by using Arrows (with CTRL or SHIFT arrows will make bigger or smaller moves).
60   For Entities element depending if you drag the Shadow the AT or the image, the moving will apply on certain Coords or on AT properties (try it...).
61 - Delete Objects or duplicate objects :
62   The shortcuts for this operation are in the OBJECTS menu. There is also 2 button above the view for it.
63 - Walls,Holes,ScrollZ have special feature when single selected.
64   You can change there shape by dragging there parts (points for Wall/Hole, upper or lower limits for ScrollZ) try it...
65 - Miscelanious : You can zoom+-, Show/Hide Background, etc...  with buttons above the VIEW.
68 ------------------------------------------
69         THE ENTITIES LIST (At the Right)
70         
71 Here is presented the kwown entities for this mod.
72 The text entry filters names of entities list.
73 The Combo box filter type of entities.
74 The bottom image show the current selected entity.
75 You can Add a spawn for an entity by selecting it and click-right "Add". The entity added will appear in the center of the VIEW.
78 ------------------------------------------
79         THE OBJECTS LIST (Bottom-Left)
80 Objects are organized in SuperTypes/Types.
81 When Clicking a SuperType or Type element, Objects of this superType/type will appears in the VIEW with Blue borders.
82 When Double Clicking a SuperType/Type element, Objects of the superType/type will be hided/showed in the VIEW and the SuperType/Type element will have a # appears/disappears at his front.
83 The exception is the NONE element, this one hide/show ALL when double clicking it.
84 (Just try it....)
85 You can add some elements in the view by right-clicking a Type, and select "Add" in the popup menu. The element will appears in the center of the view.
88 ------------------------------------------
89         THE OBJECT PROPERTY (Bottom-Right)
90 When a single elements is selected, the properties of the element appears here.
91 You can then edit them.
92 Note : for certain elements some controls are disabled.