Skip to content

Commit

Permalink
Added a F.A.Q. section for development questions to mitigate potentia…
Browse files Browse the repository at this point in the history
…l issues of onboarding new developers to the open source project.
  • Loading branch information
alexandrespallone committed Feb 13, 2023
1 parent 9c6c673 commit 407ca1c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,34 @@
<br>
Everybody knows lots of diffent FPS shooter games, from Fortnite to CS:GO, the list is longly tiresome. So, what's any different about Vitrix? Well first of all, it has a really cool name. Second of all, it is open-source! No more sneaky malware in your closed-source applications, because the code of Vitrix is fully open and accessible to the community! Well? What are you waiting for? Go ahead and download it if you haven't already, and dive into a world of Vitrix fun!

Frequently Asked Questions (FAQ):

Game Video/Screen Settings:

Q: Is there a way to change the screen’s dimensions i.e. width and height?
A: Yes! Post-cloning the repository, navigate to the /Vitrix/vitrix/menu.py file. Upon inspecting the code, the “window” object has its attribute size set to two parameters (“default_width” and “default_height”). Initializing these to different integer values will alter the game’s screen dimensions.

Q: Is there a way to toggle whether the screen is borderless or whether it displays in a windowed format?
A: Yes! Post-cloning the repository, navigate to the /Vitrix/vitrix/menu.py file. Upon inspecting the code, the “window” object has its attribute borderless which is a boolean toggle for whether the screen is windowed or borderless. As of 2/12/2023, the default setting in the source code is borderless.

Q: Is there a way to toggle whether the screen fullscreen?
A: Yes! Post-cloning the repository, navigate to the /Vitrix/vitrix/menu.py file. Upon inspecting the code, the “window” object has its attribute fullscreen which is a boolean toggle for whether the game’s contents are shown as fullscreen or not.

In Game Weapons:

Q: Where can I access source code for the weapons used in game?
A: Navigate to the directory “/Vitrix/vitrix/lib/weapons” to find the python source code for each item and its in game statistics/specifications.

Q: I see that within each weapon’s class source code that there is a texture variable being initialized to an image path? Where are these images in the repository?
A: Navigate to the directory “/Vitrix/vitrix/assets/textures” to find the images loaded into the game.

Anticheat/Multiplayer Auditing:

Q: Does Vitrix have anitcheat functionality implemented for its multiplayer gameplay?
A: Indeed! Navigate to the directory “/Vitrix/vitrix/lib/classes” and access the “anticheat.py” file to see built in precautionary user metric audits to see if gameplay is genuine in its origin.

Q: What are the metrics that Vitrix uses to access whether a player is cheating or not?
A: If user speed within the game is not within a deemed “normal” range, they will be kicked out of the game’s multiplayer session by a function call named “perform_quit()”. If the jump height integer wise does not match up with the original source code’s jump height, they will also be removed from the game. Artificial manipulated levels of player health exceeding 150 also indicate that the player is cheating which results in an automatic disconnect for the game.

<br>
<h4>You can find out everything you else you need to know in the <a href="https://github.com/ShadityZ/Vitrix/blob/docs-development/docs/mainpage.md">Official Vitrix Documentation</a>!</h4>

0 comments on commit 407ca1c

Please sign in to comment.