From a448374162a714ed93e9afb43c4e740e7a145456 Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon Date: Sun, 12 Jan 2020 00:10:37 +0100 Subject: [PATCH] Adding a .legend file --- .legend | 96 +++++++++++++++++++++++++++++++++++++++++++ main.c | 8 ++-- prefabs/game.gcprefab | 2 +- 3 files changed, 102 insertions(+), 4 deletions(-) create mode 100644 .legend diff --git a/.legend b/.legend new file mode 100644 index 0000000..1930fef --- /dev/null +++ b/.legend @@ -0,0 +1,96 @@ +The map is an xml. + +You have prefabs or complete scenes. + +A scene must have the tag and should contains a tag with every +static data to load with the scene (for the sfml, you have the , +and tags). + +A scene or a prefab may have a tag listing every entity that needs +to be created. + +To define an entity, use the tag and put components +inside the entity. + + +Valid components and there properties are: + + transform_component: allow the entity to be placed on the map. + -> Position: x, y - set the position of the entity + -> Size: x, y - set the size of an entity. + + renderer: draw the entity on the screen + -> src: give the path of the sprite to use + (should already be in the data of the scene) + -> rect (child): height, width, top, left - Use an offset of the + texture and not the whole texture. + -> animation: add an animation to the animation manager + of this entity + -> name: The name it is refered as + -> frame_count: the number of frame the animation has + -> frame_rate: the number of frame to show per second + -> rect (child): change the start offset/size of the texture + -> text: draw the inputed text on the screen instead of a texture + + fixed_to_cam: make the entity follow the camera + -> offset: set the position of the entity on the screen + (will be kept when the camera moves) + + parallax_component: make the texture of this entity move with it's movements + -> speed: apply a speed multiplier to the parallax. + + collision_component: provide collsisions + -> layer: select witch layer the entity collide with and wich layer may + see this entity. + + friction_giver: apply frictions to the entities that can have frictions when + theses entities are on contact with this one. + -> value: the ammount of friction to give + + friction_component: allow this entity to have friction + -> value: the ammount of friction that the air give to this entity + + movable_component: allow the entity to move or be moved + (is subject to acceleration and so on) + + controllable_component: tells that this entity may have inputs + (AI, Keyboard, Network...) + + keyboard_controller: allow this entity to be controlled by the keyboard + -> left: left moving key id + -> right: right moving key id + -> jump: jump moving key id. + PS: ids should confort with your rendering engine. + For the sfml, use sfml bindings. + + gravity_component: make this entity be subject to the gravity + -> force: the force of the gravity + + walk_action: allow this entity to walk using left and right values + of the controllable_component + -> acceleration: the acceleration of the walk + -> idle_trigger: at witch speed should the iddle animation be triggered + + jump_action: allow this entity to jump using the jump value + of the controllable_component + -> acceleration: the force of the acceleration + -> step_count: the number of frame to apply the jump force + -> conterforce: the ammount of force pointed downward to apply to + the entity when the jump is canceled before the end + + live_component: allow this entity to reswpan and listen to win/kill actions + -> count: the number of lives (0 or negative for infinite) + + win_component: trigger the win event when an entity with the live_component + make contact with this entity + + kill_component: make an entity that touch this one respawn if it has + the live_component. + + timer_component: update the renderer text to the time left + and kill all entities with the live_component when the timer comes to 0. + -> time: the number of seconds for this timer. + + camerafollow_component: make the camera follow this entity + PS: if multiple entities have this component, the camera will center + arround these entities. (warning: the camera doesn't zoom for now) \ No newline at end of file diff --git a/main.c b/main.c index 1625ad0..2f0c203 100644 --- a/main.c +++ b/main.c @@ -8,10 +8,12 @@ #include "runner.h" #include "my.h" -int usage(void) +int usage(const char *bin) { my_printf("My runner:\n\n\tUsage: %s [path_to_map]. \ -If no map are specified, the default one is loaded.\n"); +If no map are specified, the default one is loaded.\n\n\ +Moves:\n\tQ or D to move to the left or right\n\t\ +SPACE to jump\n", bin); return (0); } @@ -20,6 +22,6 @@ int main(int argc, char **argv) if (argc == 1) return (start_game("prefabs/game.gcprefab")); if (argc != 2 || !my_strcmp(argv[1], "-h")) - return (usage()); + return (usage(argv[0])); return (start_game(argv[1])); } \ No newline at end of file diff --git a/prefabs/game.gcprefab b/prefabs/game.gcprefab index c7930f0..044a93e 100644 --- a/prefabs/game.gcprefab +++ b/prefabs/game.gcprefab @@ -59,7 +59,7 @@ - +