Code Monkey home page Code Monkey logo

snakat's Introduction

snakat ๐Ÿ๐Ÿ˜พ

Repository size GitHub last commit License Issues Code of conduct Fork Watchers Stargazers

About ๐Ÿ“š

Have you ever imagined the classical snake game but with a cat? No? So the time has come: we present snakat! Help a hungry cat get its food and survive the wild world of pixels!

However, be careful with the walls and its own body ๐Ÿ™€. You know the rules, right?

We are making snakat using Python and Pygame. Pygame is a set of Python modules designed for writing video games.

We hope you enjoy the game ๐Ÿ˜ป.

Status ๐Ÿ“ˆ

The project is still in progress.

How to run ๐Ÿš€

Prerequisites ๐Ÿ“”

Before starting, you'll need to install the following tools: Git, Python and Pygame. Furthermore, is recommended to install a Code Editor like Visual Studio Code from Microsoft or an IDE like Pycharm from Jetbrains.

Running ๐Ÿ‘จโ€๐Ÿ’ป

# Clone this repo
$ git clone https://github.com/monikode/snakat

# Access project folder in terminal/cmd
$ cd snakat

# Run the code
$ python main.py

To use the python command it is necessary to put the python installation path in the PATH environment variable or other things depending on your operating system. More information: Mac user, Windows user, Linux user.

How to contribute ๐Ÿง

There are 4 ways to contribute to this project: solving or opening an issue, improving our documentation, or fixing a bug not founded yet.

Before contributing, pay attention to some rules:

  1. Don't forget to comment your code.
  2. By standard, you must name python packages with lowercase letters and avoid using underline. Take for example the package named as sprites.
  3. On the other hand, files are named with lowercase letters and, if necessary, you can use underline. Example: hello_world.py.
  4. Finally, functions and classes are named with lowercase letters and, if necessary, you can use underline for functions and the CapWords pattern for classes. Function example: function_name. Class example: MyClass.

For more information about the language standards, you should read the PEP 8.

Don't forget to follow our pull to request and issue templates.

Step-by-step to contribute:

  1. Fork this repo.
  2. Clone your forked repo.
  3. Create and switch to a new branch named like feature/my-feature-name.
  4. Do your changes or create new programs.
  5. Save your changes and make a commit telling what you did: git commit -m "feature: My new feature".
  6. Push your changes to your remote cloned repo: git push origin feature/my-feature-name.
  7. Submit your changes to approve by making a pull request.

In case you have questions check this guide about how to contribute to GitHub.

Here is our Code of Counduct.

License ๐Ÿ“

This project is under MIT license.

Contributors ๐Ÿค

Here are our project contributors:


Adriano Henrique

๐Ÿ‘จ๐Ÿปโ€๐ŸŽ“๐Ÿ“š

Larissa Roque

๐Ÿ‘ฉ๐Ÿปโ€๐ŸŽ“๐Ÿ“š

Manuela Cristina

๐Ÿ‘ฉ๐Ÿปโ€๐ŸŽ“๐Ÿ“š

Monike Freitas

๐Ÿ‘ฉ๐Ÿปโ€๐ŸŽ“๐Ÿ“š

Ronaldo Costa

๐Ÿ‘จ๐Ÿปโ€๐ŸŽ“๐Ÿ“š

Author ๐Ÿค“


Ronaldo Costa

Made by Ronaldo Costa. Contact me ๐Ÿ˜Ž๐Ÿ––:

snakat's People

Contributors

adriano-henrique-de-souza-andrade avatar larissaroquecarvalho avatar manupbastos avatar monikode avatar ronaldocoding avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

snakat's Issues

Add project description

Description

Our project must have a description.

Sugestion: Classical Snake Game but with a cat.

Tasks

  • [ Add a project discription]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.