singh_engine

Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

cd existing_repo
git remote add origin https://gitlab.com/choenchaip/singh_engine.git
git branch -M main
git push -uf origin main

Integrate with your tools

Collaborate with your team

Test and Deploy

Use the built-in continuous integration in GitLab.


Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.

Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name

Choose a self-explaining name for your project.

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

Libraries

objects/animated_follower_object
objects/animated_object
objects/animated_object_once
util/assets_loader
util/mixins/attackable
util/extensions/attackable_extensions
util/mixins/automatic_random_movement
background/background_color_game
background/background_image_game
Created by
base/base_game
camera/camera
camera/camera_config
geometry/circle
collision/collision_area
collision/collision_config
color_filter/color_filter_component
util/controlled_update_animation
base/custom_game_widget
decoration/decoration
decoration/decoration_with_collision
util/direction
util/mixins/direction_animation
gestures/drag_gesture
enemy/enemy
util/extensions/enemy/enemy_extensions
util/extensions/extensions
objects/flying_attack_angle_object
objects/flying_attack_object
objects/follower_object
util/follower_widget
util/functions
background/game_background
color_filter/game_color_filter
base/game_component
util/extensions/game_component_extensions
util/game_controller
game_interface/game_interface
gestures/gestures
game_interface/interface_component
util/interval_tick
joystick/joystick
joystick/joystick_action
joystick/joystick_controller
joystick/joystick_directional
util/extensions/joystick_extensions
joystick/joystick_move_to_position
lighting/lighting
lighting/lighting_component
lighting/lighting_config
map/map_assets_manager
util/map_explorer
map/map_game
map/map_paint
map/map_world
gestures/mouse_gesture
util/mixins/move_to_position_along_the_path
util/mixins/movement
util/mixins/movement_by_joystick
util/extensions/movement_extensions
collision/object_collision
player/player
util/extensions/player/player_extensions
util/mixins/pointer_detector
geometry/polygon
util/priority_layer
util/pulse_value
util/quadtree
Created by
geometry/rectangle
enemy/rotation_enemy
util/extensions/enemy/rotation_enemy_extensions
player/rotation_player
util/extensions/player/rotation_player_extensions
util/talk/say
util/mixins/sensor
geometry/shape
geometry/shape_collision
util/direction_animations/simple_animation_enum
util/direction_animations/simple_direction_animation
enemy/simple_enemy
player/simple_player
singh_engine
base/singh_engine_game
base/singh_engine_game_interface
util/singh_engine_game_ref
widgets/singh_engine_tiled_widget
widgets/singh_engine_widget
util/talk/talk_dialog
gestures/tap_gesture
util/text_damage_component
util/text_game_component
game_interface/text_interface_component
map/tile/tile
map/tile/tile_model
map/tile/tile_with_collision
tiled/model/tiled_data_object_collision
tiled/model/tiled_item_tile_set
tiled/model/tiled_object_properties
tiled/model/tiled_world_data
tiled/tiled_world_map
util/value_generator_component
util/vector2rect