-
Notifications
You must be signed in to change notification settings - Fork 11
Component review
Jan Sandström edited this page Apr 28, 2020
·
1 revision
A component review is often performed before a major release to assert that all components conform to rules defined for the components during the work leading to that release.
Component reviews are performed against the documentation in this wiki.
All components must adhere to the following requirements:
- Component design guidelines - General visual requirements for all components
- Components - General technical requirements for all components
- Enemy - Technical and design requirements for enemy placement.
Specific components must adhere to the following requirements:
-
Obstacles - General technical requirements for all obstacles
- Obstacle_bow - Specific technical requirements for bow obstacles
- Obstacle_weakwall - Specific technical requirements for bomb/map obstacles
- Obstacle_veryweakwall - Specific technical requirements for bomb obstacles
- Obstacle_flippers - Specific technical requirements for flippers obstacles
- Obstacle_glove - Specific technical requirements for glove obstacles
- Obstacle_hookshot - Specific technical requirements for hookshot obstacles
- Obstacle_lamp - Specific technical requirements for lamp obstacles
- Obstacle_puzzle - Specific technical requirements for puzzle components
- Filler - Specific technical requirements for fillers
- Treasure_open - Specific technical requirements for treasures
- Treasure_bigkey - Specific technical requirements for big chest treasures
- Door_entrance - Specific technical requirements for dungeon entrances
- Door_bigkey - Specific technical requirements for boss room entrances
The component asset manager is responsible for the state of the component base. Any contributor can participate by claiming a range of components and reporting their status to the component asset manager.
Each components is reviewed in the quest editor against the documentation above. This checklist can be used in the process:
- Does the tile positioning and the visual design of the component adhere to the rules in Component design guidelines?
- Do specific tiles, like water or floor_small, consist with the specific rules in Component design guidelines?
- Do the walls and corners in the component tile to each other and to room1 in accordance with Component design guidelines
- Does the content of the component consist with it's spatial mask?
- Does the the positioning of the content consist with it's door mask
- Does the component use the correct placeholder tiles for it's placeholder?
- Are the component's placeholders named according to the specific technical requirements for it's type?
- Does the component look proper in all implemented tileset families?
- Does the number of enemy placeholders consist with the rules in enemy