Skip to content

Shoot 'em up game, developed for the Hacktoberfest 2019 event with the Crystal Bit community.

License

Notifications You must be signed in to change notification settings

crystal-bit/space-shooter

Repository files navigation

Space Shooter

Intro scene here: https://github.com/crystal-bit/into-the-breach-opening

Space Shooter is a shoot'em-up game created for the Hacktoberfest 2019.

It's intended for people who want to learn Godot game programming in a collaborative way.

Project status

Feel free to open Pull Requests and issues.

But keep in mind that Space Shooter is not in acive development; it was intended as a 1-month project.

"Why do you accept PR if the project is not in development?"

It's useful for who wants to contribute to a welcoming project.

Eg: after the Hacktoberfest finished, a student asked me to work on this project as a University assignment.
I'm more than happy to spend time reviewing PRs and issues if someone can benefit from it.

Pre-requisites

  • Godot > 3.0.6

How can I contribute?

In two ways:

  1. Opening a new issue: did you find a bug? Do you have an idea for the gameplay? Do you want to suggest an improvement? Open a new issue.
  2. Working on an issue: take a look at the open issues: https://github.com/crystal-bit/space-shooter/issues
    Did you find something that you would like to work on? Great! Then keep reading...

Please follow these simple rules ⤵️

  1. ➡️ Write a short message in the issue itself to notify others that you are working on it.
  2. ➡️ Ask for help if you are stuck. You can push what you have, even if it is incomplete or it has some bug. We will review it and fix it.
  3. ➡️ Don't take a task if you don't have time to work on it.
  4. ➡️ Happy coding! I hope you will learn a lot during the process!

I hope these rules will help everyone having an enjoyable Hacktoberfest, avoiding conflicts!

Code style

Please follow the official GDScript style guide when making pull requests.

For the order of variables, signals, functions, please follow this order (simplified from GDQuest's guidelines):

01. Extends and class_name
02. """docstring"""

03. Signals
04. Node dependencies
05. Constants
06. Variables (properties)

08. Built-in virtual callbacks (eg: _ready, _input, _process, ...) 
09. Signal callbacks (eg: on_button_pressed, on_area_entered, on_body_entered, ...)
10. Methods

Why? Well, everyone has his own preference when writing code, but when collaborating with others it's good to respect a common style. Since Space Shooter is a learning project, I think the best choice is to follow the official style guide.

"Non parlo Inglese" ("I don't speak English!")

⚠️ NOTE: If you don't see a flag representing your nation, I'm really sorry for this. We decided to put 3 flags at max for each language for practical reasons. Feel free to say your opinion and leave a comment here-

🇮🇹 Non preoccuparti, aiutati con Google Translate e prova ad esprimere il concetto. Se proprio non riesci, scrivi in Italiano ma ricorda che sapere comunicare in Inglese è una skill importante da avere per lavorare nell'industria del software e dei videogame.

🇬🇧 / 🇺🇸 Don't worry, use Google Translate for help and try to express the concept. If you really can't, write in your language, but remember that knowing how to communicate in English is an important skill to have for working in the software and video game industry.

🇪🇸 🇦🇷 🇲🇽 (...): No se preocupe, ayúdese con Google Translate e intente expresar el concepto. Si realmente no puede, escriba en tu idioma, pero recuerde que saber cómo comunicarse en inglés es una habilidad importante para trabajar en la industria del software y los videojuegos.

🇧🇷 Não se preocupe, use o Google Tradutor para ajudá-lo e tente explicar seu conceito. Se você realmente não conseguir, escreva no seu idioma, mas lembre-se que aprender a se comunicar em inglês é uma habilidade importante para trabalhar na industria de software e video games.

🇹🇷 Dert etmeyin, Google Translate'ten yardım alın ve fikrinizi ifade etmeye çalışın. Yine de başarılı olamıyorsanız kendi dilinizde yazın, ama İngilizce iletişim kurabilmenin video oyunu ve yazılım endüstrisinde önemli bir beceri olduğunu unutmayın.

🇧🇪🇨🇭🇦🇹 (...): Mach dir keine Sorgen. Du kannst einfach Google Übersetzer verwenden, um zu versuchen, das Konzept auszudrücken. Wenn du das wirklich nicht kannst, schreibe in deiner Sprache. Aber denkst du daran, dass das Beherrschen der englischen Sprache eine wichtige Fähigkeit für die Arbeit in der Software- und Videospielbranche ist.

🇫🇷 Ne vous inquiétez pas, utilisez Google Translate pour obtenir de l'aide et essayez d'exprimer le concept, l'intention. Si vous ne pouvez vraiment pas le faire, écrivez dans votre langue, mais souvenez-vous que savoir communiquer en anglais est une compétence essentielle dans l'industrie du logiciel et des jeux vidéo.

:he: אל תדאג, אתה יכול להעזר בגוגל תרגום כדי לנסות לבטא את הרעיון שלך. אם אתה באמת לא יכול, כתוב בעברית, אך זכור שלדעת לתקשר באנגלית זו מיומנות חשובה לעבודה בענף התוכנה ומשחקי הווידיאו.

Another flag ... (see #3)

License